Adding the validate dagger function

replicatedhq · Oct 17, 2024 · fd0fe10 · fd0fe10
1 parent 9d9cce7
commit fd0fe10
Show file tree

Hide file tree

Showing 20 changed files with 203 additions and 38 deletions.
diff --git a/Makefile b/Makefile
@@ -33,16 +33,24 @@ define LDFLAGS
 "
 endef
 
-.PHONY: test
-test:
-	# pacts and unit
-	go test -tags "$(BUILDTAGS)" -v ./...
+.PHONY: test-unit
+test-unit:
+	go test -v `go list ./... | grep -v /pact` -tags "$(BUILDTAGS)"
+
+.PHONY: test-pact
+test-pact:
+	go test -v ./pact/... -tags "$(BUILDTAGS)"
 
+.PNONY: test-e2e
+test-e2e:
 	# integration and e2e
 	docker build -t replicated-cli-test -f hack/Dockerfile.testing .
 	docker run --rm --name replicated-cli-tests \
 		-v `pwd`:/go/src/github.com/replicatedhq/replicated \
-		replicated-cli-test \
+		replicated-cli-test
+
+.PHONY: test
+test: test-unit test-pact test-e2e
 
 .PHONY: publish-pact
 publish-pact:

diff --git a/dagger/compatibility.go b/dagger/compatibility.go
@@ -0,0 +1,15 @@
+package main
+
+import (
+	"context"
+	"dagger/replicated/internal/dagger"
+)
+
+func validateCompatibility(
+	ctx context.Context,
+
+	// +defaultPath="./"
+	source *dagger.Directory,
+) error {
+	return nil
+}
diff --git a/dagger/exec_utils.go b/dagger/exec_utils.go
@@ -0,0 +1,20 @@
+package main
+
+import (
+	"dagger/replicated/internal/dagger"
+	"time"
+)
+
+// CacheBustingExec is a helper function that will add a cache busting env var automatically
+// to the container. This is useful when Exec target is a dynamic event acting on an entity outside
+// of the container that you absolutely want to re-run every time.
+//
+// Temporary hack until cache controls are a thing: https://docs.dagger.io/cookbook/#invalidate-cache
+func CacheBustingExec(args []string, opts ...dagger.ContainerWithExecOpts) dagger.WithContainerFunc {
+	return func(c *dagger.Container) *dagger.Container {
+		if c == nil {
+			panic("CacheBustingExec requires a container, but container was nil")
+		}
+		return c.WithEnvVariable("DAGGER_CACHEBUSTER_CBE", time.Now().String()).WithExec(args, opts...)
+	}
+}
diff --git a/dagger/functionality.go b/dagger/functionality.go
@@ -0,0 +1,34 @@
+package main
+
+import (
+	"context"
+	"dagger/replicated/internal/dagger"
+)
+
+func validateFunctionality(
+	ctx context.Context,
+
+	// +defaultPath="./"
+	source *dagger.Directory,
+) error {
+	goModCache := dag.CacheVolume("replicated-go-mod-122")
+	goBuildCache := dag.CacheVolume("replicated-go-build-121")
+
+	// unit tests
+	unitTest := dag.Container().
+		From("golang:1.22").
+		WithMountedDirectory("/go/src/github.com/replicatedhq/replicated", source).
+		WithWorkdir("/go/src/github.com/replicatedhq/replicated").
+		WithMountedCache("/go/pkg/mod", goModCache).
+		WithEnvVariable("GOMODCACHE", "/go/pkg/mod").
+		WithMountedCache("/go/build-cache", goBuildCache).
+		WithEnvVariable("GOCACHE", "/go/build-cache").
+		With(CacheBustingExec([]string{"make", "test-unit"}))
+
+	_, err := unitTest.Stderr(ctx)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/dagger/performance.go b/dagger/performance.go
@@ -0,0 +1,15 @@
+package main
+
+import (
+	"context"
+	"dagger/replicated/internal/dagger"
+)
+
+func validatePerformance(
+	ctx context.Context,
+
+	// +defaultPath="./"
+	source *dagger.Directory,
+) error {
+	return nil
+}
diff --git a/dagger/security.go b/dagger/security.go
@@ -0,0 +1,34 @@
+package main
+
+import (
+	"context"
+	"dagger/replicated/internal/dagger"
+)
+
+func validateSecurity(
+	ctx context.Context,
+
+	// +defaultPath="./"
+	source *dagger.Directory,
+) error {
+	goModCache := dag.CacheVolume("replicated-go-mod-122")
+	goBuildCache := dag.CacheVolume("replicated-go-build-121")
+
+	// run semgrep
+	semgrep := dag.Container().
+		From("returntocorp/semgrep").
+		WithMountedDirectory("/go/src/github.com/replicatedhq/replicated", source).
+		WithWorkdir("/go/src/github.com/replicatedhq/replicated").
+		WithMountedCache("/go/pkg/mod", goModCache).
+		WithEnvVariable("GOMODCACHE", "/go/pkg/mod").
+		WithMountedCache("/go/build-cache", goBuildCache).
+		WithEnvVariable("GOCACHE", "/go/build-cache").
+		With(CacheBustingExec([]string{"semgrep", "scan", "--config=p/golang", "."}))
+
+	_, err := semgrep.Stderr(ctx)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/dagger/validate.go b/dagger/validate.go
@@ -0,0 +1,31 @@
+package main
+
+import (
+	"context"
+	"dagger/replicated/internal/dagger"
+)
+
+func (r *Replicated) Validate(
+	ctx context.Context,
+
+	// +defaultPath="./"
+	source *dagger.Directory,
+) error {
+	if err := validateSecurity(ctx, source); err != nil {
+		return err
+	}
+
+	if err := validateFunctionality(ctx, source); err != nil {
+		return err
+	}
+
+	if err := validateCompatibility(ctx, source); err != nil {
+		return err
+	}
+
+	if err := validatePerformance(ctx, source); err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/pkg/kotsclient/app_create_test.go → pact/kotsclient/app_create_test.go b/pkg/kotsclient/app_create_test.go → pact/kotsclient/app_create_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/pact-foundation/pact-go/dsl"
+	realkotsclient "github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/stretchr/testify/assert"
 )
@@ -14,7 +15,7 @@ func Test_AppCreate(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-app-create-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		createdApp, err := client.CreateKOTSApp("app-create-1")
 		assert.Nil(t, err)

diff --git a/pkg/kotsclient/app_test.go → pact/kotsclient/app_test.go b/pkg/kotsclient/app_test.go → pact/kotsclient/app_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/pact-foundation/pact-go/dsl"
+	realkotsclient "github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/stretchr/testify/assert"
 )
@@ -14,7 +15,7 @@ func Test_ListApps(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-list-apps-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		apps, err := client.ListApps(false)
 		assert.Nil(t, err)
@@ -68,7 +69,7 @@ func Test_RemoveApp(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-rm-app-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		err = client.DeleteKOTSApp("replicated-cli-rm-app-app")
 		assert.Nil(t, err)

diff --git a/pkg/kotsclient/channel_test.go → pact/kotsclient/channel_test.go b/pkg/kotsclient/channel_test.go → pact/kotsclient/channel_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/pact-foundation/pact-go/dsl"
+	realkotsclient "github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/replicatedhq/replicated/pkg/types"
 	"github.com/stretchr/testify/assert"
@@ -15,7 +16,7 @@ func Test_CreateChannel(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-create-channel-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		channel, err := client.CreateChannel("replicated-cli-create-channel-app", "New Channel", "Description")
 		assert.Nil(t, err)
@@ -64,7 +65,7 @@ func Test_ListChannels(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-list-channels-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		channels, err := client.ListChannels("replicated-cli-list-channels-app", "")
 		assert.Nil(t, err)
@@ -111,7 +112,7 @@ func Test_GetChannel(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-get-channel-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		channel, err := client.GetChannel("replicated-cli-get-channel-app", "replicated-cli-get-channel-unstable")
 		assert.Nil(t, err)
@@ -153,7 +154,7 @@ func Test_RemoveChannels(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-rm-channel-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		err = client.ArchiveChannel("replicated-cli-rm-channel-app", "replicated-cli-rm-channel-beta")
 		assert.Nil(t, err)
@@ -216,7 +217,7 @@ func Test_AddRemoveSemver(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-semver-channel-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		channel := types.Channel{
 			Name: "Unstable",

diff --git a/pkg/kotsclient/client_test.go → pact/kotsclient/client_test.go b/pkg/kotsclient/client_test.go → pact/kotsclient/client_test.go
diff --git a/pkg/kotsclient/installer_test.go → pact/kotsclient/installer_test.go b/pkg/kotsclient/installer_test.go → pact/kotsclient/installer_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/pact-foundation/pact-go/dsl"
+	realkotsclient "github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/stretchr/testify/assert"
 )
@@ -14,7 +15,7 @@ func Test_CreateInstaller(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "repl-cli-create-installer-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		installerSpec, err := client.CreateInstaller("repl-cli-create-installer-app", testInstallerYAML)
 		assert.NoError(t, err)

diff --git a/pkg/kotsclient/registry_test.go → pact/kotsclient/registry_test.go b/pkg/kotsclient/registry_test.go → pact/kotsclient/registry_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/pact-foundation/pact-go/dsl"
+	realkotsclient "github.com/replicatedhq/replicated/pkg/kotsclient"
 	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/stretchr/testify/assert"
 )
@@ -14,9 +15,9 @@ func Test_CreateRegistryDockerHubPassword(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "dockerhub",
 			Endpoint:       "index.docker.io",
 			AuthType:       "password",
@@ -74,9 +75,9 @@ func Test_CreateRegistryDockerHubAccessToken(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "dockerhub",
 			Endpoint:       "index.docker.io",
 			AuthType:       "token",
@@ -134,9 +135,9 @@ func Test_CreateRegistryECR(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "ecr",
 			Endpoint:       "0000000000.dkr.ecr.us-east-2.amazonaws.com",
 			AuthType:       "accesskey",
@@ -194,9 +195,9 @@ func Test_CreateRegistryGCR(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "gcr",
 			Endpoint:       "gcr.io",
 			AuthType:       "serviceaccount",
@@ -254,9 +255,9 @@ func Test_CreateRegistryGARServiceAccount(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "gar",
 			Endpoint:       "pkg.dev",
 			AuthType:       "serviceaccount",
@@ -314,9 +315,9 @@ func Test_CreateRegistryGARAccessToken(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-add-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
-		req := AddKOTSRegistryRequest{
+		req := realkotsclient.AddKOTSRegistryRequest{
 			Provider:       "gar",
 			Endpoint:       "pkg.dev",
 			AuthType:       "token",
@@ -374,7 +375,7 @@ func Test_RemoveRegistryDockerHubPassword(t *testing.T) {
 		u := fmt.Sprintf("http://localhost:%d", pact.Server.Port)
 
 		api := platformclient.NewHTTPClient(u, "replicated-cli-rm-registry-token")
-		client := VendorV3Client{HTTPClient: *api}
+		client := realkotsclient.VendorV3Client{HTTPClient: *api}
 
 		err = client.RemoveKOTSRegistry("index.docker.io")
 		assert.Nil(t, err)