Add tests to deployment and on push, update makefile with e2e build

Author: NHAS

.github/workflows/docker-image.yml

@@ -1,11 +1,39 @@
 name: Docker Image CI
 
-on:
-  push:
-    branches: ["main"]
+on: ["push"]
 
 jobs:
+  e2e_tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.23.1"
+
+      - name: Update repos
+        run: sudo apt update
+
+      - name: Install mingw for windows dll tests
+        run: sudo apt install -y gcc-mingw-w64
+
+      - name: Make integration tests
+        run: yes | make e2e
+
+      - name: Run tests
+        working-directory: e2e
+        run: ./e2e
+    
   build:
+    needs: test
+    if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     strategy:
       fail-fast: true

.gitignore

@@ -15,4 +15,6 @@ e2e/downloads
 e2e/cache
 e2e/keys
 e2e/data.db
-e2e/id_ed25519
+e2e/id_ed25519
+e2e/watch.log
+e2e/authorized_controllee_keys

Makefile

@@ -34,6 +34,7 @@ release: .generate_keys
 
 e2e: .generate_keys
 	go build -ldflags="github.com/NHAS/reverse_ssh/e2e.Version=$(shell git describe --tags)" -o e2e ./...
+	cp internal/client/keys/private_key.pub e2e/authorized_controllee_keys
 
 client: .generate_keys
 	go build $(BUILD_FLAGS) -ldflags="$(LDFLAGS_RELEASE)" -o bin ./cmd/client

e2e/basics.go

@@ -1,11 +1,11 @@
 package main
 
-import (
-	"os"
-)
+import "log"
 
-func basics(serverLog *os.File) {
+func basics() {
+	log.Println("Starting basic tests")
 	conditionExec("version", Version, 0, "", 0)
 	conditionExec("ls", "No RSSH clients connected", 1, "", 0)
 	conditionExec("who", user, 0, "", 0)
+	log.Println("Finished basic tests")
 }

e2e/client_tests.go

@@ -0,0 +1,47 @@
+package main
+
+import (
+	"io"
+	"log"
+	"os"
+	"os/exec"
+	"time"
+)
+
+func clientTests() {
+	log.Println("Starting client tests")
+	kill := runPrecompiledClient()
+	defer kill()
+
+	conditionExec("ls", "127.0.0.1:", 0, "", 0)
+	conditionExec("exec -y * echo hello", "hello", 0, "", 0)
+
+	log.Println("Ending client tests")
+
+}
+
+func runPrecompiledClient() func() {
+	cmd := exec.Command("./client", "--foreground", "-d", listenAddr)
+
+	r, w, err := os.Pipe()
+	if err != nil {
+		log.Fatal("failed to create for client pipe: ", err)
+	}
+
+	cmd.Stdout = io.MultiWriter(os.Stdout, w)
+	cmd.Stderr = io.MultiWriter(os.Stdout, w)
+
+	err = cmd.Start()
+	if err != nil {
+		log.Fatal("failed to start client:", err)
+	}
+	serverLog = r
+
+	time.Sleep(1 * time.Second)
+
+	return func() {
+		if cmd.Process != nil {
+			cmd.Process.Kill()
+		}
+	}
+}

e2e/link_tests.go

@@ -0,0 +1,37 @@
+package main
+
+import (
+	"log"
+	"net/http"
+)
+
+func linkTests() {
+	log.Println("Starting link tests")
+
+	conditionExec("link --name linuxbin", "linuxbin", 0, "", 0)
+	conditionExec("link --goos linux --shared-object --name sharedlinux", "sharedlinux", 0, "", 0)
+
+	conditionExec("link --goos windows --name windowsbin", "windowsbin", 0, "", 0)
+	conditionExec("link --goos windows --shared-object --name windowsdll", "windowsdll", 0, "", 0)
+
+	resp, err := http.Get("http://" + listenAddr + "/linuxbin")
+	if err != nil {
+		log.Fatal("failed to fetch linuxbin: ", err)
+	}
+	resp.Body.Close()
+	if resp.StatusCode != 200 {
+		log.Fatal("should have returned 200 for created linux binary, instead got: ", resp.Status)
+	}
+
+	resp, err = http.Get("http://" + listenAddr + "/windowsdll")
+	if err != nil {
+		log.Fatal("failed to fetch windowsdll: ", err)
+	}
+	resp.Body.Close()
+	if resp.StatusCode != 200 {
+		log.Fatal("should have returned 200 for created windowsdll, instead got: ", resp.Status)
+	}
+
+	log.Println("Ending link tests")
+
+}

e2e/main.go

@@ -62,6 +62,8 @@ func main() {
 		log.Fatalf("Missing required files: %v", missingFiles)
 	}
 
+	reset()
+
 	kill := runServer()
 	defer kill()
 
@@ -82,7 +84,10 @@ func main() {
 	}
 	defer client.Close()
 
-	basics(serverLog)
+	// integration tests
+	basics()
+	clientTests()
+	linkTests()
 
 	log.Println("All passed!")
 }
@@ -98,7 +103,7 @@ func conditionExec(command, expectedOutput string, exitCode int, serverLogExpect
 	if err != nil {
 
 		if exitError, ok := err.(*ssh.ExitError); !ok || (ok && exitCode != exitError.ExitStatus()) {
-			log.Fatalf("Failed to execute command %q: %v", command, err)
+			log.Fatalf("Failed to execute command %q: %v: %q", command, err, output)
 		}
 	}
 
@@ -164,3 +169,10 @@ func runServer() func() {
 		}
 	}
 }
+
+func reset() {
+	os.RemoveAll("./cache")
+	os.RemoveAll("./downloads")
+	os.RemoveAll("./keys")
+	os.RemoveAll("./data.db")
+}