Merge pull request #133 from GSA-TTS/zjr/ssh-map_route-int_setup

Go CFD: SSH, Map Route, Integration Test Setup & Teardown

Author: zjrgov

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

@@ -5,10 +5,6 @@ name: "CF Driver: Go Build & Test"
 
 on: [pull_request]
 
-defaults:
-  run:
-    working-directory: runner-manager/cfd
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -17,12 +13,9 @@ jobs:
 
       - name: Set up Go
         uses: actions/setup-go@v5
-        with:
-          go-version-file: runner-manager/cfd/go.mod
-          cache-dependency-path: runner-manager/cfd/go.sum
 
       - name: Install dependencies
-        run: go get .
+        run: go get ./...
 
       - name: Check formatting
         run: test -z "$(gofmt -l .)"

.lazy.lua

@@ -0,0 +1,21 @@
+return {
+	{
+		"nvim-neotest/neotest",
+		config = function()
+			---@diagnostic disable-next-line: missing-fields
+			require("neotest").setup({
+				adapters = {
+					require("neotest-golang")({
+						go_test_args = { "-v", "-race", "-count=1", "-tags=integration" },
+						go_list_args = { "-tags=integration" },
+						dap_go_opts = {
+							delve = {
+								build_flags = { "-tags=integration" },
+							},
+						},
+					}),
+				},
+			})
+		end,
+	},
+}

runner-manager/cfd/Makefile Makefilerunner-manager/cfd/Makefile renamed to Makefile

@@ -8,10 +8,10 @@ vet: fmt
 	go vet ./...
 
 test: vet
-	go test ./...
+	go test -v ./...
 
 integration: vet
-	go test -count=1 --tags=integration ./...
+	go test -v -count=1 --tags=integration ./...
 
 build: vet
-	go build
+	go build ./runner-manager/cfd

runner-manager/cfd/go.mod go.modrunner-manager/cfd/go.mod renamed to go.mod

@@ -1,4 +1,4 @@
-module github.com/GSA-TTS/gitlab-runner-cloudgov/runner/cfd
+module github.com/GSA-TTS/gitlab-runner-cloudgov
 
 go 1.23.5
 

runner-manager/cfd/go.sum go.sumrunner-manager/cfd/go.sum renamed to go.sum

@@ -45,5 +45,7 @@ golang.org/x/oauth2 v0.21.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbht
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

runner-manager/cfd/.vscode/launch.json

@@ -50,12 +50,14 @@ 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.
+Integration tests take a little effort get working.
+
+1. Set your `cf target` to `sandbox-gsa`.
+2. Run `./sh/integration_setup.sh`.
+   a. This will output credentials and `cf target` info to the `testdata` directories for `./cloudgov` and `./cmd/drive`.
+   b. It will also create a sample app in your sandbox account to be used for testing.
+3. Run integration tests with `make integration`
+4. Whenever you're ready, you can clean up the credentials & app made during setup with `./sh/integration_teardown.sh`.
 
 ## Builds
 

runner-manager/cfd/README.md

@@ -73,7 +73,7 @@ func castApp(app *resource.App) *App {
 	if app == nil || app.GUID == "" {
 		return nil
 	}
-	return &(App{Name: app.Name, GUID: app.GUID, State: app.State})
+	return &(App{Name: app.Name, GUID: app.GUID, State: app.State, SpaceGUID: app.Relationships.Space.Data.GUID})
 }
 
 func castApps(apps []*resource.App) []*App {
@@ -104,3 +104,35 @@ func (cf *CFClientAPI) appsList() ([]*App, error) {
 	}
 	return castApps(apps), nil
 }
+
+func (cf *CFClientAPI) sshCode() (string, error) {
+	ctx := context.Background()
+	return cf.conn().SSHCode(ctx)
+}
+
+func (cf *CFClientAPI) mapRoute(
+	ctx context.Context,
+	app *App,
+	domain string, space string, host string, path string, port int,
+) error {
+	opts := resource.NewRouteCreateWithHost(domain, space, host, path, port)
+
+	route, err := cf.conn().Routes.Create(ctx, opts)
+	if err != nil {
+		return err
+	}
+
+	_, err = cf.conn().Routes.InsertDestinations(
+		ctx,
+		route.GUID,
+		[]*resource.RouteDestinationInsertOrReplace{{
+			App: resource.RouteDestinationApp{GUID: &app.GUID},
+		}},
+	)
+	return err
+}
+
+// addNetworkPolicy implements ClientAPI.
+func (cf *CFClientAPI) addNetworkPolicy(app *App, dest string, space string, port string) error {
+	panic("unimplemented")
+}

runner-manager/cfd/cloudgov/cf_client.go

@@ -1,25 +1,18 @@
 package cloudgov
 
-import (
-	"errors"
-	"fmt"
+import "context"
 
-	"github.com/cloudfoundry/go-cfclient/v3/resource"
-)
-
-// Stuff we'll need to implement, for ref
-//
-// mapRoute()
-//
-// addNetworkPolicy()
-// removeNetworkPolicy()
 type ClientAPI interface {
 	connect(url string, creds *Creds) error
 
 	appGet(id string) (*App, error)
 	appPush(m *AppManifest) (*App, error)
 	appDelete(id string) error
 	appsList() (apps []*App, err error)
+
+	sshCode() (string, error)
+	mapRoute(ctx context.Context, app *App, domain string, space string, host string, path string, port int) error
+	addNetworkPolicy(app *App, dest string, space string, port string) error
 }
 
 type CredsGetter interface {
@@ -46,8 +39,10 @@ func (e CloudGovClientError) Error() string {
 	return e.msg
 }
 
-// TODO: we should pull this out of VCAP_APPLICATION
-const apiRootURLDefault = "https://api.fr.cloud.gov"
+const (
+	apiRootURLDefault  = "https://api.fr-stage.cloud.gov"
+	internalDomainGUID = "8a5d6a8c-cfc1-4fc4-afc9-aa563ff9df5e"
+)
 
 func New(i ClientAPI, o *Opts) (*Client, error) {
 	if o == nil {
@@ -83,9 +78,10 @@ func (c *Client) Connect() (*Client, error) {
 }
 
 type App struct {
-	Name  string
-	GUID  string
-	State string
+	Name      string
+	GUID      string
+	State     string
+	SpaceGUID string
 }
 
 func (c *Client) AppGet(id string) (*App, error) {
@@ -102,34 +98,15 @@ func (c *Client) AppsList() ([]*App, error) {
 
 // TODO: this abstraction might belong in /cmd,
 // unless it can be further generalized to all pushes
-func (c *Client) ServicePush(manifest *AppManifest) (*App, error) {
+func (c *Client) Push(manifest *AppManifest) (*App, error) {
 	containerID := manifest.Name
 
 	if containerID == "" {
-		return nil, CloudGovClientError{"ServicePush: AppManifest.Name must be defined"}
+		return nil, CloudGovClientError{"Push: AppManifest.Name must be defined"}
 	}
 
 	if manifest.OrgName == "" || manifest.SpaceName == "" {
-		return nil, CloudGovClientError{"ServicePush: AppManifest must have Org and Space names"}
-	}
-
-	// check for an old instance of the service, delete if found
-	app, err := c.AppGet(containerID)
-	if err != nil {
-		var cferr resource.CloudFoundryError
-		if errors.As(err, &cferr) {
-			err = nil
-			if cferr.Code != 10010 {
-				return nil, fmt.Errorf("unexpected cferr checking for existing app: %w", cferr)
-			}
-		} else {
-			return nil, fmt.Errorf("error checking for existing service (%v): %w", containerID, err)
-		}
-	}
-	if app != nil {
-		if err := c.AppDelete(containerID); err != nil {
-			return nil, fmt.Errorf("error deleting existing service (%v): %w", containerID, err)
-		}
+		return nil, CloudGovClientError{"Push: AppManifest must have Org and Space names"}
 	}
 
 	return c.appPush(manifest)
@@ -144,7 +121,7 @@ func (c *Client) ServicesPush(manifests []*AppManifest) ([]*App, error) {
 	apps := make([]*App, len(manifests))
 
 	for i, s := range manifests {
-		app, err := c.ServicePush(s)
+		app, err := c.Push(s)
 		if err != nil {
 			return nil, err
 		}
@@ -153,3 +130,11 @@ func (c *Client) ServicesPush(manifests []*AppManifest) ([]*App, error) {
 
 	return apps, nil
 }
+
+func (c *Client) SSHCode() (string, error) {
+	return c.sshCode()
+}
+
+func (c *Client) MapServiceRoute(app *App) error {
+	return c.mapRoute(context.Background(), app, internalDomainGUID, app.SpaceGUID, app.Name, "", 0)
+}