feat: goldpinger collector and analyser (replicatedhq#1398)

* feat: goldpinger analyser

Analyser to generate a report from goldpinger results

* Add goldpinger testdata

* Goldpinger collector

* Improvements after running tests

* More minor updates after further testing

* Better error message if a container fails to start

* A few more updates

* Add goldpinger e2e test

* Update schemas

* Clean up help installs in e2e tests

* Add resource limits to goldpinger pods

* Some minor improvements

* Some more changes noted when writing docs

* Update schemas

* A few more updates when testing with kURL

* Log goldpinger tests

* Tests before exit code

config/crds/troubleshoot.sh_analyzers.yaml

@@ -559,6 +559,57 @@ spec:
                       required:
                       - outcomes
                       type: object
+                    goldpinger:
+                      properties:
+                        annotations:
+                          additionalProperties:
+                            type: string
+                          type: object
+                        checkName:
+                          type: string
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        filePath:
+                          type: string
+                        outcomes:
+                          items:
+                            properties:
+                              fail:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              pass:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              warn:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                            type: object
+                          type: array
+                        strict:
+                          type: BoolString
+                      required:
+                      - collectorName
+                      type: object
                     imagePullSecret:
                       properties:
                         annotations:

config/crds/troubleshoot.sh_collectors.yaml

@@ -318,6 +318,35 @@ spec:
                       - namespace
                       - selector
                       type: object
+                    goldpinger:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        namespace:
+                          type: string
+                        podLaunchOptions:
+                          properties:
+                            image:
+                              type: string
+                            imagePullSecret:
+                              properties:
+                                data:
+                                  additionalProperties:
+                                    type: string
+                                  type: object
+                                name:
+                                  type: string
+                                type:
+                                  type: string
+                              type: object
+                            namespace:
+                              type: string
+                            serviceAccountName:
+                              type: string
+                          type: object
+                      type: object
                     helm:
                       properties:
                         collectorName:

config/crds/troubleshoot.sh_preflights.yaml

@@ -559,6 +559,57 @@ spec:
                       required:
                       - outcomes
                       type: object
+                    goldpinger:
+                      properties:
+                        annotations:
+                          additionalProperties:
+                            type: string
+                          type: object
+                        checkName:
+                          type: string
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        filePath:
+                          type: string
+                        outcomes:
+                          items:
+                            properties:
+                              fail:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              pass:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              warn:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                            type: object
+                          type: array
+                        strict:
+                          type: BoolString
+                      required:
+                      - collectorName
+                      type: object
                     imagePullSecret:
                       properties:
                         annotations:
@@ -1828,6 +1879,35 @@ spec:
                       - namespace
                       - selector
                       type: object
+                    goldpinger:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        namespace:
+                          type: string
+                        podLaunchOptions:
+                          properties:
+                            image:
+                              type: string
+                            imagePullSecret:
+                              properties:
+                                data:
+                                  additionalProperties:
+                                    type: string
+                                  type: object
+                                name:
+                                  type: string
+                                type:
+                                  type: string
+                              type: object
+                            namespace:
+                              type: string
+                            serviceAccountName:
+                              type: string
+                          type: object
+                      type: object
                     helm:
                       properties:
                         collectorName:

config/crds/troubleshoot.sh_supportbundles.yaml

@@ -590,6 +590,57 @@ spec:
                       required:
                       - outcomes
                       type: object
+                    goldpinger:
+                      properties:
+                        annotations:
+                          additionalProperties:
+                            type: string
+                          type: object
+                        checkName:
+                          type: string
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        filePath:
+                          type: string
+                        outcomes:
+                          items:
+                            properties:
+                              fail:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              pass:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                              warn:
+                                properties:
+                                  message:
+                                    type: string
+                                  uri:
+                                    type: string
+                                  when:
+                                    type: string
+                                type: object
+                            type: object
+                          type: array
+                        strict:
+                          type: BoolString
+                      required:
+                      - collectorName
+                      type: object
                     imagePullSecret:
                       properties:
                         annotations:
@@ -1859,6 +1910,35 @@ spec:
                       - namespace
                       - selector
                       type: object
+                    goldpinger:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                        namespace:
+                          type: string
+                        podLaunchOptions:
+                          properties:
+                            image:
+                              type: string
+                            imagePullSecret:
+                              properties:
+                                data:
+                                  additionalProperties:
+                                    type: string
+                                  type: object
+                                name:
+                                  type: string
+                                type:
+                                  type: string
+                              type: object
+                            namespace:
+                              type: string
+                            serviceAccountName:
+                              type: string
+                          type: object
+                      type: object
                     helm:
                       properties:
                         collectorName:

internal/testutils/utils.go

@@ -15,16 +15,25 @@ import (
 
 func GetTestFixture(t *testing.T, path string) string {
 	t.Helper()
-	p := path
-	if !filepath.IsAbs(path) {
-		p = filepath.Join("../../testdata", path)
-	}
-	b, err := os.ReadFile(p)
+
+	b, err := os.ReadFile(TestFixtureFilePath(t, path))
 	require.NoError(t, err)
 	return string(b)
 }
 
-// FileDir returns the directory of the current source file.
+func TestFixtureFilePath(t *testing.T, path string) string {
+	t.Helper()
+
+	if !filepath.IsAbs(path) {
+		p, err := filepath.Abs(filepath.Join(FileDir(), "../../testdata", path))
+		require.NoError(t, err)
+		return p
+	} else {
+		return path
+	}
+}
+
+// FileDir returns the directory of this source file
 func FileDir() string {
 	_, filename, _, _ := runtime.Caller(0)
 	return filepath.Dir(filename)

internal/util/util.go

@@ -74,3 +74,15 @@ func Append[T any](target []T, src []T) []T {
 	}
 	return append(target, src...)
 }
+
+// IsInCluster returns true if the code is running within a process
+// inside a kubernetes pod
+func IsInCluster() bool {
+	// This is a best effort check, it's not guaranteed to be accurate
+	host, port := os.Getenv("KUBERNETES_SERVICE_HOST"), os.Getenv("KUBERNETES_SERVICE_PORT")
+	if len(host) == 0 || len(port) == 0 {
+		return false
+	}
+
+	return true
+}

pkg/analyze/analyzer.go

@@ -244,6 +244,8 @@ func getAnalyzer(analyzer *troubleshootv1beta2.Analyze) Analyzer {
 		return &AnalyzeClusterResource{analyzer: analyzer.ClusterResource}
 	case analyzer.Certificates != nil:
 		return &AnalyzeCertificates{analyzer: analyzer.Certificates}
+	case analyzer.Goldpinger != nil:
+		return &AnalyzeGoldpinger{analyzer: analyzer.Goldpinger}
 	default:
 		return nil
 	}