CHANGELOG.md

@@ -1,16 +1,3 @@
-## [1.3.0-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.2.1-rc.1...v1.3.0-rc.1) (2024-03-02)
-
-
-### Features
-
-* **validation:** add empty probe lists validation ([82b6034](https://git.ext.icikowski.pl/go/kubeprobes/commit/82b6034625089450d3de734edd8eb95ea35aff2f))
-
-
-### Refactoring
-
-* **names:** refactor handler fetching methods' names ([373c803](https://git.ext.icikowski.pl/go/kubeprobes/commit/373c803c00499a7e607cdd0ad99315dcd6e2919d))
-* **validation:** improve errors joining ([ea92b29](https://git.ext.icikowski.pl/go/kubeprobes/commit/ea92b2979cbdb67507d934725434f21b0456be03))
-
 ## [1.2.1-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.2.0...v1.2.1-rc.1) (2024-03-02)
 
 

README.md

@@ -82,11 +82,11 @@ kp, _ := kubeprobes.New(
     // ...
 )
 
-livenessHandler := kp.LivenessHandler()
+livenessHandler := kp.GetLivenessHandler()
-readinessHandler := kp.ReadinessHandler()
+readinessHandler := kp.GetReadinessHandler()
 ```
 
-Those handler can be used for manually mounting them on other servers/routers/muxes (eg. `go-chi/chi`, `gorilla/mux`, `http`'s `ServeMux` etc.).
+Those handler can be used for manually mounting them on other servers/routers/muxes (eg. `go-chi/chi`, `gorilla/mux`, `http`'s `ServeMux` etc.). 
 
 ## Example usage
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "kubeprobes",
-  "version": "1.3.0-rc.1",
+  "version": "1.2.1-rc.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "kubeprobes",
-      "version": "1.3.0-rc.1",
+      "version": "1.2.1-rc.1",
       "devDependencies": {
         "@saithodev/semantic-release-gitea": "^2.1.0",
         "@semantic-release/changelog": "^6.0.3",

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "kubeprobes",
-  "version": "1.3.0-rc.1",
+  "version": "1.2.1-rc.1",
   "scripts": {
     "release": "./node_modules/.bin/semantic-release"
   },

probes.go

@@ -35,36 +35,44 @@ func New(options ...Option) (Kubeprobes, error) {
 }
 
 func (kp *kubeprobes) validate() error {
-	var err error
+	errs := []error{}
+
 	if kp.pathLive == "" {
-		err = errors.Join(err, fmt.Errorf("liveness probe path must not be empty"))
+		errs = append(
+			errs,
+			fmt.Errorf("liveness probe path must not be empty"),
+		)
 	}
 
 	if kp.pathReady == "" {
-		err = errors.Join(err, fmt.Errorf("readiness probe path must not be empty"))
+		errs = append(
+			errs,
+			fmt.Errorf("readiness probe path must not be empty"),
+		)
 	}
 
 	if !strings.HasPrefix(kp.pathLive, "/") {
-		err = errors.Join(err, fmt.Errorf("liveness probe path must start with slash (current: %q)", kp.pathLive))
+		errs = append(
+			errs,
+			fmt.Errorf("liveness probe path must start with slash (current: %q)", kp.pathLive),
+		)
 	}
 
 	if !strings.HasPrefix(kp.pathReady, "/") {
-		err = errors.Join(err, fmt.Errorf("readiness probe path must start with slash (current: %q)", kp.pathReady))
+		errs = append(
+			errs,
+			fmt.Errorf("readiness probe path must start with slash (current: %q)", kp.pathReady),
+		)
 	}
 
 	if kp.pathLive == kp.pathReady {
-		err = errors.Join(err, fmt.Errorf("liveness and readiness probes have the same values (both %q)", kp.pathLive))
+		errs = append(
+			errs,
+			fmt.Errorf("liveness and readiness probes have the same values (both %q)", kp.pathLive),
+		)
 	}
 
-	if len(kp.livenessProbes) == 0 {
+	return errors.Join(errs...)
-		err = errors.Join(err, fmt.Errorf("no liveness probes defined"))
-	}
-
-	if len(kp.readinessProbes) == 0 {
-		err = errors.Join(err, fmt.Errorf("no readiness probes defined"))
-	}
-
-	return err
 }
 
 func (kp *kubeprobes) handleLiveness(w http.ResponseWriter, _ *http.Request) {
@@ -85,13 +93,13 @@ func (kp *kubeprobes) handleReadiness(w http.ResponseWriter, _ *http.Request) {
 	}
 }
 
-// LivenessHandler implements Kubeprobes.
+// GetLivenessHandler implements Kubeprobes.
-func (kp *kubeprobes) LivenessHandler() http.Handler {
+func (kp *kubeprobes) GetLivenessHandler() http.Handler {
 	return http.HandlerFunc(kp.handleLiveness)
 }
 
-// ReadinessHandler implements Kubeprobes.
+// GetReadinessHandler implements Kubeprobes.
-func (kp *kubeprobes) ReadinessHandler() http.Handler {
+func (kp *kubeprobes) GetReadinessHandler() http.Handler {
 	return http.HandlerFunc(kp.handleReadiness)
 }
 

probes_test.go

@@ -15,100 +15,7 @@ func getStatusFromEndpoint(t *testing.T, client *http.Client, endpoint string) i
 	return resp.StatusCode
 }
 
-func TestValidation(t *testing.T) {
+func TestKubeprobes(t *testing.T) {
-	var (
-		live  = NewStatefulProbe()
-		ready = NewStatefulProbe()
-	)
-
-	tests := map[string]struct {
-		opts          []Option
-		expectedError bool
-	}{
-		"no modifications and no error": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-			},
-		},
-		"modifications and no error": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithLivenessPath("/livez"),
-				WithReadinessPath("/readyz"),
-			},
-		},
-		"missing liveness probes": {
-			opts: []Option{
-				WithReadinessStatefulProbes(ready),
-			},
-			expectedError: true,
-		},
-		"missing readiness probes": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-			},
-			expectedError: true,
-		},
-		"liveness probe path empty": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithLivenessPath(""),
-			},
-			expectedError: true,
-		},
-		"readiness probe path empty": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithReadinessPath(""),
-			},
-			expectedError: true,
-		},
-		"liveness probe path does not start with slash": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithLivenessPath("livez"),
-			},
-			expectedError: true,
-		},
-		"readiness probe path does not start with slash": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithReadinessPath("readyz"),
-			},
-			expectedError: true,
-		},
-		"liveness and readiness probe paths are equal": {
-			opts: []Option{
-				WithLivenessStatefulProbes(live),
-				WithReadinessStatefulProbes(ready),
-				WithLivenessPath("/check"),
-				WithReadinessPath("/check"),
-			},
-			expectedError: true,
-		},
-	}
-
-	for name, tc := range tests {
-		name, tc := name, tc
-		t.Run(name, func(t *testing.T) {
-			_, err := New(tc.opts...)
-			switch {
-			case err == nil && tc.expectedError:
-				t.Error("expected error, but no error was returned")
-			case err != nil && !tc.expectedError:
-				t.Errorf("expected no error but got %v", err)
-			}
-		})
-	}
-}
-
-func TestHandler(t *testing.T) {
 	live, ready := NewStatefulProbe(), NewStatefulProbe()
 
 	tests := map[string]struct {
@@ -143,13 +50,10 @@ func TestHandler(t *testing.T) {
 		},
 	}
 
-	kp, err := New(
+	kp, _ := New(
 		WithLivenessStatefulProbes(live),
 		WithReadinessStatefulProbes(ready),
 	)
-	if err != nil {
-		t.Errorf("expected no error, got %v", err)
-	}
 
 	srv := httptest.NewServer(kp)
 	defer srv.Close()

types.go

@@ -6,10 +6,10 @@ import "net/http"
 type Kubeprobes interface {
 	http.Handler
 
-	// LivenessHandler returns [http.Handler] for liveness probes.
+	// GetLivenessHandler returns [http.Handler] for liveness probes.
-	LivenessHandler() http.Handler
+	GetLivenessHandler() http.Handler
-	// ReadinessHandler returns [http.Handler] for readiness probes.
+	// GetReadinessHandler returns [http.Handler] for readiness probes.
-	ReadinessHandler() http.Handler
+	GetReadinessHandler() http.Handler
 }
 
 // Option represents a [Kubeprobes] constructor option.