Use Go for integration tests; test output exactly

Author: pjcdawkins

.github/workflows/ci.yml

@@ -56,3 +56,6 @@ jobs:
         uses: golangci/golangci-lint-action@v3
         with:
           version: v1.59
+
+      - name: Run tests
+        run: make test

.gitignore

@@ -4,6 +4,9 @@ php-*
 !internal/legacy/archives/windows_php.ini.tpl
 completion
 
+# Executable built with `go build ./cmd/platform` (or `make build`)
+/platform
+
 # Binaries for programs and plugins
 *.exe
 *.exe~

.gitlab-ci.yml

@@ -2,7 +2,7 @@ stages:
   - check
   - php
   - build
-  - behave-test
+  - integration-test
   - release
 
 .go-cache:
@@ -127,18 +127,14 @@ build:
       - dist/
     expire_in: 1 day
 
-behave-test-linux:
-  stage: behave-test
+integration-test-linux:
+  stage: integration-test
+  image: cimg/go:1.22
+  extends: .go-cache
   dependencies:
     - build
-  variables:
-    PATH_CLI: platform_linux_amd64_v1/platform
-  before_script:
-    - apt-get install -y python3 python3-pip
-    - pip3 install --no-cache-dir behave sh selenium requests
-  script:
-    - bash tests/test-behave.sh
-  image: pjcdawkins/platformsh-cli
+  script: |
+    TEST_CLI_PATH=$PWD/dist/platform_linux_amd64_v1/platform go test -failfast -mod=readonly -v ./tests/integration/...
 
 release:
   stage: release
@@ -152,7 +148,7 @@ release:
     - make release
   dependencies:
     - unit-test-lint
-    - behave-test-linux
+    - integration-test-linux
     - build-php-linux-arm
     - build-php-linux-x86
     - build-php-macos-arm

Makefile

@@ -62,7 +62,7 @@ php: $(PHP_BINARY_PATH)
 
 .PHONY: goreleaser
 goreleaser:
-	go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)
+	command -v goreleaser >/dev/null || go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)
 
 .PHONY: single
 single: goreleaser internal/legacy/archives/platform.phar php ## Build a single target release for Platform.sh or Upsun
@@ -83,11 +83,17 @@ release: goreleaser clean-phar internal/legacy/archives/platform.phar php ## Rel
 
 .PHONY: test
 test: ## Run unit tests
-	go clean -testcache
 	go test -v -race -mod=readonly -cover ./...
 
+platform: internal/legacy/archives/platform.phar php
+	go build ./cmd/platform
+
+.PHONY: integration-test
+integration-test: platform
+	TEST_CLI_PATH="$(PWD)/platform" go test -failfast -mod=readonly -v ./tests/integration/...
+
 golangci-lint:
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
+	command -v golangci-lint >/dev/null || go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
 
 .PHONY: lint
 lint: golangci-lint ## Run linter

commands/root.go

@@ -57,6 +57,9 @@ func newRootCommand(cnf *config.Config, assets *vendorization.VendorAssets) *cob
 				viper.Set("no-interaction", true)
 				cmd.SetErr(io.Discard)
 			}
+			if cnf.Application.Version != "" {
+				version = cnf.Application.Version
+			}
 			if viper.GetBool("version") {
 				versionCommand.Run(cmd, []string{})
 				os.Exit(0)

internal/config/schema.go

@@ -29,6 +29,7 @@ type Config struct {
 		UserStateFile   string `validate:"omitempty" yaml:"user_state_file"`   // defaults to "state.json"
 		WritableUserDir string `validate:"omitempty" yaml:"writable_user_dir"` // defaults to UserConfigDir
 		TempSubDir      string `validate:"omitempty" yaml:"tmp_sub_dir"`       // defaults to Slug+"-tmp"
+		Version         string `validate:"omitempty"`                          // defaults to version variable set by GoReleaser
 	} `validate:"required"`
 	Updates struct {
 		Check         bool `validate:"omitempty"`                       // defaults to true

scripts/generate_test_data.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+set -e
+cd "$DIR/.."
+make clean-phar platform
+export data_dir="$(realpath tests/integration/data)"
+export TEST_CLI_PATH="$(realpath ./platform)"
+export CLI_CONFIG_FILE="$data_dir/config.yaml"
+export TEST_CLI_NO_INTERACTION=1
+
+# Clear the working directory to avoid this repository being detected as a "project".
+cd /
+echo "Using command: $TEST_CLI_PATH"
+"$TEST_CLI_PATH" version
+for c in help list version 'help list' 'help create'; do
+  export filename="$data_dir"/"$c".stdout.txt
+  echo "Generating $filename"
+  COLUMNS=120 "$TEST_CLI_PATH" $c > "$filename"
+done