feat: CI (GitHub Actions)

Author: KEINOS

.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+# =============================================================================
+#  Docker Container for LinuxBrew Download and Basic Execution Test
+# =============================================================================
+# [Choice] https://hub.docker.com/r/homebrew/brew/tags
+ARG VARIANT="latest"
+
+# -----------------------------------------------------------------------------
+#  Main Stage
+# -----------------------------------------------------------------------------
+FROM homebrew/brew:${VARIANT}
+
+RUN \
+    brew install shellspec/shellspec/shellspec && \
+    # Smoke test
+    shellspec -v

.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/alpine
+{
+	"name": "homebrew",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Available 'VARIANT': https://hub.docker.com/r/homebrew/brew/tags
+		"args": { "VARIANT": "latest" }
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	// Note that some extensions may not work in Alpine Linux. See https://aka.ms/vscode-remote/linux.
+	"extensions": [],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "uname -a",
+
+	// Replace when using a ptrace-based debugger like C++, Go, and Rust
+	// "runArgs": [ "--init", "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	//"remoteUser": "vscode"
+}

.github/workflows/go-pallet.yml

@@ -0,0 +1,17 @@
+name: "go-pallet"
+
+on:
+  workflow_dispatch:
+  push:
+  schedule:
+    # Runs at 16:30 UTC on day-of-month 2 (Every day-of-month 2 at AM 01:30 JST, my time)
+    # See: https://crontab.guru/
+    - cron: '30 16 2 * *'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run tests on container
+        run: docker-compose run go-pallet

Tests/.shellspec

@@ -0,0 +1,12 @@
+--require spec_helper
+
+## Default kcov (coverage) options
+# --kcov-options "--include-path=. --path-strip-level=1"
+# --kcov-options "--include-pattern=.sh"
+# --kcov-options "--exclude-pattern=/.shellspec,/spec/,/coverage/,/report/"
+
+## Example: Include script "myprog" with no extension
+# --kcov-options "--include-pattern=.sh,myprog"
+
+## Example: Only specified files/directories
+# --kcov-options "--include-pattern=myprog,/lib/"

Tests/README.md

@@ -0,0 +1,20 @@
+# Tests To Download via Homebrew on Linux
+
+This directory contains simple [ShellSpec](https://github.com/shellspec/shellspec) tests.
+For example, download and run its basic commands.
+See [go-pallet_spec.sh](./spec/go-pallet_spec.sh) for example.
+
+## Note
+
+- Create Test Files
+  - Place them under `./spec/` dir.
+  - File name format: `<app_name>_spec.sh`
+    - Ex.) `go-pallet_spec.sh`
+- Add test runner to [docker-compose.yml](../docker-compose.yml)
+- Add the workflow to [workflows](../.github/workflows)
+  - Add the status workflow status badge to [README.md](../README.md) as well.
+
+## Reference
+
+- [Examples to write tests](https://github.com/shellspec/shellspec/tree/master/examples/spec) @ github.com/shellspec/shellspec
+- [Syntax References](https://github.com/shellspec/shellspec/blob/master/docs/references.md) @ github.com/shellspec/shellspec

Tests/spec/go-pallet_spec.sh

@@ -0,0 +1,18 @@
+#shellcheck shell=sh
+
+Describe 'go-pallet'
+  # Download Test
+  It 'should success on install via brew'
+    When call brew install KEINOS/apps/go-pallet
+    The status should be success
+    The stderr should include "Tapping keinos/apps"
+    The output should include "🍺  /home/linuxbrew/.linuxbrew/Cellar/go-pallet"
+  End
+
+  # Smoke Test
+  It 'should success and contain "pallet" in the output on version print'
+    When run pallet -v
+    The status should be success
+    The output should match pattern "pallet *"
+  End
+End

Tests/spec/spec_helper.sh

@@ -0,0 +1,24 @@
+# shellcheck shell=sh
+
+# Defining variables and functions here will affect all specfiles.
+# Change shell options inside a function may cause different behavior,
+# so it is better to set them here.
+# set -eu
+
+# This callback function will be invoked only once before loading specfiles.
+spec_helper_precheck() {
+  # Available functions: info, warn, error, abort, setenv, unsetenv
+  # Available variables: VERSION, SHELL_TYPE, SHELL_VERSION
+  : minimum_version "0.28.1"
+}
+
+# This callback function will be invoked after a specfile has been loaded.
+spec_helper_loaded() {
+  :
+}
+
+# This callback function will be invoked after core modules has been loaded.
+spec_helper_configure() {
+  # Available functions: import, before_each, after_each, before_all, after_all
+  : import 'support/custom_matcher'
+}

docker-compose.yml

@@ -0,0 +1,21 @@
+# =============================================================================
+#  LinuxBrew Download & Basic Functionality Test on Docker Container
+# =============================================================================
+# - Requirements: docker
+# - How to test:
+#   - All-in-one
+#     docker-compose up
+#   - à-la-carte
+#     docker-compose run go-pallet
+version: "3.9"
+services:
+  go-pallet:
+    build:
+      context: ./.devcontainer
+      dockerfile: ./Dockerfile
+      args:
+        VARIANT: latest
+    volumes:
+      - ./Tests:/workspaces/Tests
+    working_dir: /workspaces/Tests
+    entrypoint: shellspec ./spec/go-pallet_spec.sh