Merge pull request #1823 from kart2bc/config-valid

skip dns validation for http_proxy

Author: jochenehret

README.md

@@ -105,6 +105,7 @@ include_app_syslog_tcp
 * `admin_password`: Password of the admin user above.
 * `apps_domain`: A shared domain that tests can use to create subdomains that will route to applications also created in the tests, without scheme (HTTP/S) specified.
 * `skip_ssl_validation`: Set to true if using an invalid (e.g. self-signed) cert for traffic routed to your CF instance; this is generally always true for BOSH-Lite deployments of CF.
+* `skip_dns_validation`: Skip DNS validation for CF API and apps domain. Use true for proxy environments. Default:false
 
 ##### Optional parameters:
 `include_*` parameters are used to specify whether to skip tests based on how a deployment is configured.

helpers/config/config.go

@@ -39,6 +39,7 @@ type CatsConfig interface {
 	GetIncludeVolumeServices() bool
 	GetShouldKeepUser() bool
 	GetSkipSSLValidation() bool
+	GetSkipDNSValidation() bool
 	GetUseExistingUser() bool
 
 	GetAddExistingUserToExistingSpace() bool

helpers/config/config_struct.go

@@ -40,6 +40,7 @@ type config struct {
 	IsolationSegmentTCPDomain *string `json:"isolation_segment_tcp_domain"`
 
 	SkipSSLValidation *bool `json:"skip_ssl_validation"`
+	SkipDNSValidation *bool `json:"skip_dns_validation"`
 
 	ArtifactsDirectory *string `json:"artifacts_directory"`
 
@@ -556,6 +557,11 @@ func validateApiEndpoint(config *config) error {
 		host = u.Path
 	}
 
+	// Skip DNS validation if configured (useful for HTTP proxy environments)
+	if config.GetSkipDNSValidation() {
+		return nil
+	}
+
 	if _, err = net.LookupHost(host); err != nil {
 		return fmt.Errorf("* Invalid configuration for 'api' <%s>: %s", config.GetApiEndpoint(), err)
 	}
@@ -580,6 +586,11 @@ func validateAppsDomain(config *config) error {
 		host = u.Path
 	}
 
+	// Skip DNS validation if configured (useful for HTTP proxy environments)
+	if config.GetSkipDNSValidation() {
+		return nil
+	}
+
 	if _, err = net.LookupHost(madeUpAppHostname); err != nil {
 		return fmt.Errorf("* Invalid configuration for 'apps_domain' <%s>: %s", config.GetAppsDomain(), err)
 	}
@@ -866,6 +877,13 @@ func (c *config) GetSkipSSLValidation() bool {
 	return *c.SkipSSLValidation
 }
 
+func (c *config) GetSkipDNSValidation() bool {
+	if c.SkipDNSValidation == nil {
+		return false
+	}
+	return *c.SkipDNSValidation
+}
+
 func (c *config) GetArtifactsDirectory() string {
 	return *c.ArtifactsDirectory
 }

helpers/config/config_test.go

@@ -27,13 +27,14 @@ type testConfig struct {
 	requiredConfig
 
 	// timeouts
-	DefaultTimeout               *int `json:"default_timeout,omitempty"`
-	CfPushTimeout                *int `json:"cf_push_timeout,omitempty"`
-	LongCurlTimeout              *int `json:"long_curl_timeout,omitempty"`
-	BrokerStartTimeout           *int `json:"broker_start_timeout,omitempty"`
-	AsyncServiceOperationTimeout *int `json:"async_service_operation_timeout,omitempty"`
-	DetectTimeout                *int `json:"detect_timeout,omitempty"`
-	SleepTimeout                 *int `json:"sleep_timeout,omitempty"`
+	DefaultTimeout               *int  `json:"default_timeout,omitempty"`
+	CfPushTimeout                *int  `json:"cf_push_timeout,omitempty"`
+	LongCurlTimeout              *int  `json:"long_curl_timeout,omitempty"`
+	BrokerStartTimeout           *int  `json:"broker_start_timeout,omitempty"`
+	AsyncServiceOperationTimeout *int  `json:"async_service_operation_timeout,omitempty"`
+	DetectTimeout                *int  `json:"detect_timeout,omitempty"`
+	SleepTimeout                 *int  `json:"sleep_timeout,omitempty"`
+	SkipDNSValidation            *bool `json:"skip_dns_validation"`
 
 	TimeoutScale *float64 `json:"timeout_scale,omitempty"`
 
@@ -124,6 +125,7 @@ type nullConfig struct {
 	IsolationSegmentDomain *string `json:"isolation_segment_domain"`
 
 	SkipSSLValidation *bool `json:"skip_ssl_validation"`
+	SkipDNSValidation *bool `json:"skip_dns_validation"`
 
 	ArtifactsDirectory *string `json:"artifacts_directory"`
 
@@ -948,6 +950,63 @@ var _ = Describe("Config", func() {
 		})
 	})
 
+	Describe("GetSkipDNSValidation", func() {
+		Context("when skip_dns_validation is not set", func() {
+			It("returns false (default)", func() {
+				config, err := cfg.NewCatsConfig(tmpFilePath)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(config.GetSkipDNSValidation()).To(BeFalse())
+			})
+		})
+
+		Context("when skip_dns_validation is set to true", func() {
+			BeforeEach(func() {
+				testCfg.SkipDNSValidation = ptrToBool(true)
+			})
+
+			It("returns true", func() {
+				config, err := cfg.NewCatsConfig(tmpFilePath)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(config.GetSkipDNSValidation()).To(BeTrue())
+			})
+
+			Context("with unresolvable apps domain", func() {
+				BeforeEach(func() {
+					testCfg.AppsDomain = ptrToString("apps.domain.example.com")
+				})
+
+				It("skips DNS lookup for apps domain", func() {
+					config, err := cfg.NewCatsConfig(tmpFilePath)
+					Expect(err).NotTo(HaveOccurred())
+					Expect(config.GetAppsDomain()).To(Equal("apps.domain.example.com"))
+				})
+			})
+		})
+
+		Context("when skip_dns_validation is set to false", func() {
+			BeforeEach(func() {
+				testCfg.SkipDNSValidation = ptrToBool(false)
+			})
+
+			It("returns false", func() {
+				config, err := cfg.NewCatsConfig(tmpFilePath)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(config.GetSkipDNSValidation()).To(BeFalse())
+			})
+			Context("with unresolvable apps domain", func() {
+				BeforeEach(func() {
+					testCfg.AppsDomain = ptrToString("domain.example.com.does-not-exist")
+				})
+
+				It("performs DNS lookup for apps domain", func() {
+					_, err := cfg.NewCatsConfig(tmpFilePath)
+					Expect(err).To(HaveOccurred())
+					Expect(err.Error()).To(ContainSubstring("no such host"))
+				})
+			})
+		})
+	})
+
 	Describe("GetAdminUser", func() {
 		It("returns the admin user", func() {
 			c, err := cfg.NewCatsConfig(tmpFilePath)