CI Fix: use docker for linux and local for mac and windows (#14)

.github/workflows/test-macos.yml

@@ -0,0 +1,21 @@
+on: 
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+name: Test-MacOs
+jobs:
+  test:
+    runs-on: macos-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup config script 
+        # using locals for mac-OS because github CI mac platforms don't have docker
+        run: make prep-ci-local
+      - name: Test
+        run: go test -v ./...

.github/workflows/test-ssh.yml

@@ -0,0 +1,21 @@
+on: 
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+name: Test-Linux
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup SSH server and config
+        # run docker ssh container for ssh tests
+        run: make prep-ci-ssh
+      - name: Test
+        run: go test -v ./...

.github/workflows/test-windows.yml

@@ -0,0 +1,25 @@
+on: 
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+name: Test-Windows
+jobs:
+  test:
+    runs-on: windows-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.16
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Choco Install make
+        uses: crazy-max/ghaction-chocolatey@v1
+        with:
+          args: install make
+      - name: Setup config script 
+        # using locals for Windows because github CI Windows platforms don't have docker
+        run: make prep-ci-local-windows
+      - name: Test
+        run: go test -v ./...

.gitignore

@@ -11,3 +11,6 @@ vendor/
 *.swp
 
 docker-compose.yaml
+ssh-key/ci/
+config-ci.yaml
+config-test.yaml

Makefile

@@ -0,0 +1,20 @@
+# Example:
+#   make
+#   make prep-ci-ssh
+.PHONY: prep-ci-ssh
+# Creates the ssh keys and docker container for running test
+prep-ci-ssh:
+	./scripts/prep-test-ssh.sh
+	cat config-test.yaml
+
+.PHONY: prep-ci-locals
+prep-ci-local:
+	cp ./scripts/config.local.yaml config-test.yaml
+	cat config-test.yaml
+
+.PHONY: prep-ci-local-windows
+# Because we are using make, we can use linux cp and cat commands
+prep-ci-local-windows:
+	cp ".\scripts\config.local.yaml" ".\config-test.yaml"
+	cat config-test.yaml
+

config.example.yaml

@@ -14,7 +14,7 @@ hosts:
         type: ssh
         username: root 
         password: somethingSecret
-        port: 33
+        port: 2222
     "192.0.1.4":
       connection: 
         type: local

integration/integration_test.go

@@ -5,6 +5,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/bisohns/saido/config"
 	"github.com/bisohns/saido/driver"
 	"github.com/bisohns/saido/inspector"
 )
@@ -17,6 +18,7 @@ func NewWebForTest() driver.Driver {
 }
 
 func NewSSHForTest() driver.Driver {
+	_ = config.GetConfig()
 	return &driver.SSH{
 		User:            "dev",
 		Host:            "127.0.0.1",

scripts/config.local.yaml

@@ -0,0 +1,11 @@
+# Config file for local connection
+hosts:
+  children:
+    "127.0.0.1":
+      connection:
+        type: local
+
+metrics:
+- memory
+- cpu
+

scripts/prep-test-ssh.sh

@@ -0,0 +1,27 @@
+set -e
+# Creates a docker container with ssh and a config file for connecting to it
+SSH_KEY_NAME=${SSH_KEY_NAME:-ci-test-key}
+SSH_KEY_PATH=$(pwd)/ssh-key/ci
+SSH_USER=ci-dev
+rm -rf $SSH_KEY_PATH
+mkdir -p $SSH_KEY_PATH
+ssh-keygen -f "$SSH_KEY_PATH/${SSH_KEY_NAME}" -N ""
+docker kill saido-linux-sshserver | true
+docker run -d -p 2222:2222 -e USER_NAME=$SSH_USER --name saido-linux-sshserver -v ${SSH_KEY_PATH}/${SSH_KEY_NAME}.pub:/config/.ssh/authorized_keys linuxserver/openssh-server
+cat <<EOF > config-test.yaml
+hosts:
+  children:
+    "$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" saido-linux-sshserver)":
+      connection:
+        type: ssh
+        port: 2222
+        username: ${SSH_USER}
+        private_key_path: $(pwd)/${SSH_KEY_NAME}
+    "127.0.0.1":
+      connection:
+        type: local
+
+metrics:
+- memory
+- cpu
+EOF