Merging Go Driver branch into main

.github/workflows/cf-driver-go.yml

@@ -0,0 +1,37 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: "CF Driver: Go Build & Test"
+
+on: [pull_request]
+
+defaults:
+  run:
+    working-directory: runner/cfd
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: runner/cfd/go.mod
+          cache-dependency-path: runner/cfd/go.sum
+
+      - name: Install dependencies
+        run: go get .
+
+      - name: Check formatting
+        run: test -z "$(gofmt -l .)"
+
+      - name: Vet
+        run: go vet ./...
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...

.gitignore

@@ -36,3 +36,6 @@ override.tf.json
 
 # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
 # example: *tfplan*
+
+**/testdata/.*
+!**/testdata/.*.sample

runner/cfd/.gitignore

@@ -0,0 +1,22 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env

runner/cfd/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug main.go",
+      "type": "go",
+      "request": "launch",
+      "program": "main.go"
+    }
+  ]
+}

runner/cfd/Makefile

@@ -0,0 +1,17 @@
+.DEFAULT_GOAL := build
+
+.PHONY:fmt vet build test integration
+fmt:
+	go fmt ./...
+
+vet: fmt
+	go vet ./...
+
+test: vet
+	go test ./...
+
+integration: vet
+	go test -count=1 --tags=integration ./...
+
+build: vet
+	go build

runner/cfd/README.md

@@ -0,0 +1,62 @@
+# CloudFoundry (cloud.gov) driver
+
+This is a _driver_ developed for use with `gitlab-runner`’s [Custom executor](https://docs.gitlab.com/runner/executors/custom.html) to prepare, run, and clean up runner managers, workers, and services.
+
+## Go setup
+
+### Install Go
+
+You can use Homebrew to install Go on MacOS (it is generally unnecessary to use a version manager). You could also download Go packages for Linux, Mac, and Windows from [Go's website](https://go.dev/doc/install).
+
+```sh
+brew install go
+```
+
+### Manage dependencies
+
+Manage project dependencies with `go` & `go mod`. Go programs are divided first into _modules_ and then into _packages_. Dependencies are listed in `./go.mod`.
+
+#### To download dependencies
+
+To download deps as listed in `./go.mod`, run:
+
+```sh
+go mod download
+```
+
+Or, to walk the project and as needed install & remove modules while updating `./go.mod` & `./go.sum` accordingly:
+
+```sh
+go mod tidy
+```
+
+#### To `get` new dependencies
+
+While `go mod tidy` can install dependencies you've already imported in your packages, you can also install them explicitly:
+
+```sh
+go get github.com/google/some-mod/pkg
+```
+
+## Running tests
+
+### Unit tests
+
+The simplest way to run tests—or the one with the least typing, at least—is with `make`.
+
+```sh
+make test
+```
+
+### Integration tests
+
+We only have one integration test right now, and to get it running you'll need to do a bit of local setup.
+
+1. You will need to first get a username & password for some space on cloud.gov that has at least one app.
+1. Then you can add those credentials to `./cg/testdata/.cg_creds` in the style of the `.cg_creds.sample` file there.
+1. Run the test with `make integration`, which should give you an error and, in its output, show you what the resulting JSON looks like.
+1. Copy that JSON result over to the last line of your `.cg_creds` file and run `make integration` again, this time it should succeed.
+
+## Builds
+
+You can also run a build with `make` (`make build`, or simply `make`), but it won't do you much good because we aren't set up to do anything with an executable yet.

runner/cfd/cg/cf_adapter.go

@@ -0,0 +1,51 @@
+package cg
+
+import (
+	"context"
+
+	"github.com/cloudfoundry/go-cfclient/v3/client"
+	"github.com/cloudfoundry/go-cfclient/v3/config"
+	"github.com/cloudfoundry/go-cfclient/v3/resource"
+)
+
+type GoCFClientAdapter struct {
+	_con *client.Client
+}
+
+func (cf *GoCFClientAdapter) connect(url string, creds *Creds) error {
+	cfg, err := config.New(url, config.UserPassword(creds.Username, creds.Password))
+	if err != nil {
+		return err
+	}
+
+	con, err := client.New(cfg)
+	if err != nil {
+		return err
+	}
+
+	cf._con = con
+	return nil
+}
+
+func (cf *GoCFClientAdapter) conn() *client.Client {
+	if cf._con != nil {
+		return cf._con
+	}
+	panic("go-cfclient adapter is not connected")
+}
+
+func castApps(apps []*resource.App) []*App {
+	Apps := make([]*App, len(apps))
+	for idx, app := range apps {
+		Apps[idx] = &(App{app.GUID, app.Name, app.State})
+	}
+	return Apps
+}
+
+func (cf *GoCFClientAdapter) getApps() ([]*App, error) {
+	apps, err := cf.conn().Applications.ListAll(context.Background(), nil)
+	if err != nil {
+		return nil, err
+	}
+	return castApps(apps), nil
+}

runner/cfd/cg/cg.go

@@ -0,0 +1,78 @@
+package cg
+
+type App struct {
+	Id    string
+	Name  string
+	State string
+}
+
+// Stuff we'll need to implement, for ref
+//
+// mapRoute()
+//
+// addNetworkPolicy()
+// removeNetworkPolicy()
+//
+// appGet()
+// appCmd()
+// appPush()
+// appDelete()
+type CloudI interface {
+	getApps() (apps []*App, err error)
+	connect(url string, creds *Creds) error
+}
+
+type CredI interface {
+	getCreds() (*Creds, error)
+}
+
+type Opts struct {
+	CredI
+	Creds *Creds
+
+	APIRootURL string
+}
+
+type CG struct {
+	CloudI
+	*Opts
+}
+
+const apiRootURLDefault = "https://api.fr.cloud.gov"
+
+func New(i CloudI, o *Opts) (*CG, error) {
+	if o == nil {
+		o = &Opts{CredI: EnvCredsGetter{}}
+	}
+	cg := &CG{i, o}
+	return cg.Connect()
+}
+
+func (c *CG) apiRootURL() string {
+	if c.APIRootURL == "" {
+		return apiRootURLDefault
+	}
+	return c.APIRootURL
+}
+
+func (c *CG) creds() (*Creds, error) {
+	if c.Creds.isEmpty() {
+		return c.getCreds()
+	}
+	return c.Creds, nil
+}
+
+func (c *CG) Connect() (*CG, error) {
+	creds, err := c.creds()
+	if err != nil {
+		return nil, err
+	}
+	if err := c.connect(c.apiRootURL(), creds); err != nil {
+		return nil, err
+	}
+	return c, nil
+}
+
+func (c *CG) GetApps() ([]*App, error) {
+	return c.getApps()
+}

runner/cfd/cg/cg_integration_test.go

@@ -0,0 +1,87 @@
+//go:build integration
+
+package cg_test
+
+import (
+	"bufio"
+	"encoding/json"
+	"os"
+	"testing"
+
+	"github.com/GSA-TTS/gitlab-runner-cloudgov/runner/cfd/cg"
+	"github.com/google/go-cmp/cmp"
+)
+
+func Test_CFAdapter_GetApps(t *testing.T) {
+	var u, p, want string
+	var l int
+
+	path := "./testdata/.cg_creds"
+	f, err := os.Open(path)
+	if err != nil {
+		t.Errorf(
+			"Error opening testdata file = %v\n\033[1;33mDid you forget to create `%v`?\033[0m",
+			err, path,
+		)
+		return
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+
+scanning:
+	for scanner.Scan() {
+		text := scanner.Text()
+
+		if text[0] == '#' {
+			continue
+		}
+
+		switch l {
+		case 0:
+			u = text
+		case 1:
+			p = text
+		case 2:
+			want = text
+			break scanning
+		}
+
+		l++
+	}
+
+	if err := scanner.Err(); err != nil {
+		t.Errorf("Error scanning testdata file = %v", err)
+		return
+	}
+
+	if u == "" || p == "" || want == "" {
+		t.Error("Could not load variables from testdata")
+		return
+	}
+
+	cgClient, err := cg.New(&cg.GoCFClientAdapter{}, &cg.Opts{
+		Creds: &cg.Creds{Username: u, Password: p},
+	})
+	if err != nil {
+		t.Errorf("Error getting cgClient = %v", err)
+		return
+	}
+
+	apps, err := cgClient.GetApps()
+	if err != nil {
+		t.Errorf("Error running GetApps() = %v", err)
+		return
+	}
+
+	got, err := json.Marshal(apps)
+	if err != nil {
+		t.Errorf("Error marshalling apps to json = %v", err)
+		return
+	}
+
+	if diff := cmp.Diff(string(got), want); diff != "" {
+		t.Errorf("mismatch (-got +want):\n%s", diff)
+		return
+	}
+}