Add docker app test to file-based service binding test

Author: jochenehret

README.md

@@ -359,7 +359,7 @@ Test Group Name| Description
 `cnb` | Tests our ability to use cloud native buildpacks.
 `detect` | Tests the ability of the platform to detect the correct buildpack for compiling an application if no buildpack is explicitly specified.
 `docker`| Tests our ability to run docker containers on Diego and that we handle docker metadata correctly.
-`file-based service bindings`| Tests file-based service bindings for a buildpack and a CNB app.
+`file-based service bindings`| Tests file-based service bindings for a buildpack app, a CNB app and a Docker app.
 `internet_dependent`| Tests the feature of being able to specify a buildpack via a Github URL.  As such, this depends on your Cloud Foundry application containers having access to the Internet.  You should take into account the configuration of the network into which you've deployed your Cloud Foundry, as well as any security group settings applied to application containers.
 `isolation_segments` | This test group requires that Diego be deployed with a minimum of 2 cells. One of those cells must have been deployed with a `placement_tag`. If the deployment has been deployed with a routing isolation segment, `isolation_segment_domain` must also be set. For more information, please refer to the [Isolation Segments documentation](https://docs.cloudfoundry.org/adminguide/isolation-segments.html).
 `route_services` | Tests the [Route Services](https://docs.cloudfoundry.org/services/route-services.html) feature of Cloud Foundry.

cats_suite_helpers/cats_suite_helpers.go

@@ -112,6 +112,7 @@ func CNBDescribe(description string, callback func()) bool {
 const (
 	BuildpackLifecycle string = "buildpack"
 	CNBLifecycle              = "CNB"
+	DockerLifecycle           = "Docker"
 )
 
 func FileBasedServiceBindingsDescribe(description string, lifecycle string, callback func()) bool {
@@ -123,6 +124,9 @@ func FileBasedServiceBindingsDescribe(description string, lifecycle string, call
 			if lifecycle == CNBLifecycle && (!Config.GetIncludeFileBasedServiceBindings() || !Config.GetIncludeCNB()) {
 				Skip(skip_messages.SkipFileBasedServiceBindingsCnbApp)
 			}
+			if lifecycle == DockerLifecycle && (!Config.GetIncludeFileBasedServiceBindings() || !Config.GetIncludeDocker()) {
+				Skip(skip_messages.SkipFileBasedServiceBindingsDockerApp)
+			}
 		})
 		Describe(description, callback)
 	})

file_based_service_bindings/file_based_service_bindings.go

@@ -25,6 +25,11 @@ var _ = FileBasedServiceBindingsDescribe("Enabling file based service binding fo
 	callback(CNBLifecycle)
 })
 
+var _ = FileBasedServiceBindingsDescribe("Enabling file based service binding for a Docker app", DockerLifecycle, func() {
+	callback(DockerLifecycle)
+})
+
+
 var callback = func(lifecycle string) {
 	var appName, serviceName string
 
@@ -65,7 +70,7 @@ var callback = func(lifecycle string) {
 		Eventually(cf.Cf("delete-service", serviceName, "-f").Wait()).Should(Exit(0))
 	})
 
-	It("creates the required files in the app container", func() {
+	FIt("creates the required files in the app container", func() {
 		tags := "list, of, tags"
 		creds := `{"username": "admin", "password":"pa55woRD"}`
 		Expect(cf.Cf("create-user-provided-service", serviceName, "-p", creds, "-t", tags).Wait()).To(Exit(0))
@@ -77,6 +82,9 @@ var callback = func(lifecycle string) {
 		if lifecycle == CNBLifecycle {
 			Expect(cf.Cf("create-app", appName, "--app-type", "cnb", "--buildpack", Config.GetGoBuildpackName()).Wait()).To(Exit(0))
 		}
+		if lifecycle == DockerLifecycle {
+			Expect(cf.Cf("create-app", appName, "--app-type", "docker").Wait()).To(Exit(0))
+		}
 		appGuid := app_helpers.GetAppGuid(appName)
 
 		appFeatureUrl := fmt.Sprintf("/v3/apps/%s/features/file-based-service-bindings", appGuid)
@@ -100,6 +108,14 @@ var callback = func(lifecycle string) {
 				"-p", assets.NewAssets().CatnipSrc,
 			).Wait(Config.CfPushTimeoutDuration())).To(Exit(0))
 		}
+		if lifecycle == DockerLifecycle {
+			Expect(cf.Cf(
+				"push",
+				appName,
+				"--docker-image", Config.GetCatnipDockerAppImage(),
+				"-m", DEFAULT_MEMORY_LIMIT,
+			).Wait(Config.CfPushTimeoutDuration())).To(Exit(0))
+		}
 
 		checkFileContent("binding-guid", getServiceBindingGuid(appGuid, serviceGuid))
 		checkFileContent("instance-guid", serviceGuid)

helpers/config/config.go

@@ -111,6 +111,7 @@ type CatsConfig interface {
 	SleepTimeoutDuration() time.Duration
 
 	GetPublicDockerAppImage() string
+	GetCatnipDockerAppImage() string
 }
 
 func NewCatsConfig(path string) (CatsConfig, error) {

helpers/config/config_struct.go

@@ -116,6 +116,7 @@ type config struct {
 	PrivateDockerRegistryUsername *string `json:"private_docker_registry_username"`
 	PrivateDockerRegistryPassword *string `json:"private_docker_registry_password"`
 	PublicDockerAppImage          *string `json:"public_docker_app_image"`
+	CatnipDockerAppImage          *string `json:"catnip_docker_app_image"`
 
 	UnallocatedIPForSecurityGroup *string `json:"unallocated_ip_for_security_group"`
 
@@ -240,6 +241,8 @@ func getDefaults() config {
 	defaults.PrivateDockerRegistryUsername = ptrToString("")
 	defaults.PrivateDockerRegistryPassword = ptrToString("")
 	defaults.PublicDockerAppImage = ptrToString("cloudfoundry/diego-docker-app:latest")
+	// TODO use "latest" tag (?)
+	defaults.CatnipDockerAppImage = ptrToString("ghcr.io/cloudfoundry/catnip-app:file-based-service-bindings-docker-app")
 
 	defaults.UnallocatedIPForSecurityGroup = ptrToString("10.0.244.255")
 
@@ -292,6 +295,12 @@ func validateConfig(config *config) error {
 
 	}
 
+	err = validateCatnipDockerAppImage(config)
+	if err != nil {
+		errs = errors.Join(errs, err)
+
+	}
+
 	err = validatePrivateDockerRegistry(config)
 	if err != nil {
 		errs = errors.Join(errs, err)
@@ -602,6 +611,16 @@ func validatePublicDockerAppImage(config *config) error {
 	return nil
 }
 
+func validateCatnipDockerAppImage(config *config) error {
+	if config.CatnipDockerAppImage == nil {
+		return fmt.Errorf("* 'catnip_docker_app_image' must not be null")
+	}
+	if config.GetCatnipDockerAppImage() == "" {
+		return fmt.Errorf("* Invalid configuration: 'catnip_docker_app_image' must be set to a valid image source")
+	}
+	return nil
+}
+
 func validatePrivateDockerRegistry(config *config) error {
 	if config.IncludePrivateDockerRegistry == nil {
 		return fmt.Errorf("* 'include_private_docker_registry' must not be null")
@@ -1123,6 +1142,10 @@ func (c *config) GetPublicDockerAppImage() string {
 	return *c.PublicDockerAppImage
 }
 
+func (c *config) GetCatnipDockerAppImage() string {
+	return *c.CatnipDockerAppImage
+}
+
 func (c *config) GetUnallocatedIPForSecurityGroup() string {
 	return *c.UnallocatedIPForSecurityGroup
 }

helpers/config/config_test.go

@@ -42,6 +42,7 @@ type testConfig struct {
 	PrivateDockerRegistryUsername *string `json:"private_docker_registry_username,omitempty"`
 	PrivateDockerRegistryPassword *string `json:"private_docker_registry_password,omitempty"`
 	PublicDockerAppImage          *string `json:"public_docker_app_image,omitempty"`
+	CatnipDockerAppImage          *string `json:"catnip_docker_app_image,omitempty"`
 
 	IsolationSegmentName   *string `json:"isolation_segment_name,omitempty"`
 	IsolationSegmentDomain *string `json:"isolation_segment_domain,omitempty"`
@@ -633,6 +634,32 @@ var _ = Describe("Config", func() {
 		})
 	})
 
+	Context("when including catnip_docker_app_image", func() {
+		Context("when image name is set", func() {
+			var image = "some-image"
+			BeforeEach(func() {
+				testCfg.CatnipDockerAppImage = ptrToString(image)
+			})
+
+			It("has the value in the config", func() {
+				config, err := cfg.NewCatsConfig(tmpFilePath)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(config.GetCatnipDockerAppImage()).To(Equal(image))
+			})
+		})
+
+		Context("when image is an empty string", func() {
+			BeforeEach(func() {
+				testCfg.CatnipDockerAppImage = ptrToString("")
+			})
+
+			It("returns an error", func() {
+				_, err := cfg.NewCatsConfig(tmpFilePath)
+				Expect(err).To(MatchError("* Invalid configuration: 'catnip_docker_app_image' must be set to a valid image source"))
+			})
+		})
+	})
+
 	Context("when including isolation segment tests", func() {
 		BeforeEach(func() {
 			testCfg.IncludeIsolationSegments = ptrToBool(true)

helpers/skip_messages/skip_messages.go

@@ -11,6 +11,7 @@ const SkipCNBMessage = `Skipping this test because config.IncludeCNB is set to '
 NOTE: Ensure CNB lifecycle is enabled on your platform before enabling this test.`
 const SkipFileBasedServiceBindingsBuildpackApp = `Skipping this test because config.IncludeFileBasedServiceBindings is set to 'false'.`
 const SkipFileBasedServiceBindingsCnbApp = `Skipping this test because config.IncludeFileBasedServiceBindings and/or config.IncludeCNB are set to 'false'.`
+const SkipFileBasedServiceBindingsDockerApp = `Skipping this test because config.IncludeFileBasedServiceBindings and/or config.IncludeDocker are set to 'false'.`
 const SkipInternetDependentMessage = `Skipping this test because config.IncludeInternetDependent is set to 'false'.
 NOTE: Ensure that your platform has access to the internet before running this test.`
 const SkipPrivateDockerRegistryMessage = `Skipping this test because config.IncludePrivateDockerRegistry is set to 'false'.