-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Platforms connection in health-check (#325)
* Async health check * Tests adaptation * Make health configurable externally * Install health later * Export ConvertStatus function * Fix health settings validation * Attach logger to health * Address PR comments * Configuration per indicator and refactoring * Add health status listener * Minor tweaks * Fix indicator interval type * Fix tests * Remove unused import * Extract indicator configuration and address PR comments * Add error to panic * Address PR comments * minor fix * Add active status to platform * Platforms connection in health * Add tests * Fix formatting * Hide platform details on unauthorized healthcheck * Rename migrations * Fix test last migration * Add default value to migration * Last Active default value * Initial fix health configuration * fix failing tests * Address PR comments * Refactor platform indicator * Strip indicator error on unauthorized request * Fix formatting * Fix squash tag handling
- Loading branch information
1 parent
f30dcba
commit 63c53a2
Showing
17 changed files
with
685 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
/* | ||
* Copyright 2018 The Service Manager Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package healthcheck | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"github.com/Peripli/service-manager/pkg/health" | ||
"github.com/Peripli/service-manager/pkg/types" | ||
"github.com/Peripli/service-manager/storage" | ||
) | ||
|
||
// NewPlatformIndicator returns new health indicator for platforms of given type | ||
func NewPlatformIndicator(ctx context.Context, repository storage.Repository, fatal func(*types.Platform) bool) health.Indicator { | ||
if fatal == nil { | ||
fatal = func(platform *types.Platform) bool { | ||
return true | ||
} | ||
} | ||
return &platformIndicator{ | ||
ctx: ctx, | ||
repository: repository, | ||
fatal: fatal, | ||
} | ||
} | ||
|
||
type platformIndicator struct { | ||
repository storage.Repository | ||
ctx context.Context | ||
fatal func(*types.Platform) bool | ||
} | ||
|
||
// Name returns the name of the indicator | ||
func (pi *platformIndicator) Name() string { | ||
return health.PlatformsIndicatorName | ||
} | ||
|
||
// Status returns status of the health check | ||
func (pi *platformIndicator) Status() (interface{}, error) { | ||
objList, err := pi.repository.List(pi.ctx, types.PlatformType) | ||
if err != nil { | ||
return nil, fmt.Errorf("could not fetch platforms health from storage: %v", err) | ||
} | ||
platforms := objList.(*types.Platforms).Platforms | ||
|
||
details := make(map[string]*health.Health) | ||
inactivePlatforms := 0 | ||
fatalInactivePlatforms := 0 | ||
for _, platform := range platforms { | ||
if platform.Active { | ||
details[platform.Name] = health.New().WithStatus(health.StatusUp). | ||
WithDetail("type", platform.Type) | ||
} else { | ||
details[platform.Name] = health.New().WithStatus(health.StatusDown). | ||
WithDetail("since", platform.LastActive). | ||
WithDetail("type", platform.Type) | ||
inactivePlatforms++ | ||
if pi.fatal(platform) { | ||
fatalInactivePlatforms++ | ||
} | ||
} | ||
} | ||
|
||
if fatalInactivePlatforms > 0 { | ||
err = fmt.Errorf("there are %d inactive platforms %d of them are fatal", inactivePlatforms, fatalInactivePlatforms) | ||
} | ||
|
||
return details, err | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
/* | ||
* Copyright 2018 The Service Manager Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package healthcheck | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"github.com/Peripli/service-manager/pkg/health" | ||
"github.com/Peripli/service-manager/pkg/types" | ||
storagefakes2 "github.com/Peripli/service-manager/storage/storagefakes" | ||
. "github.com/onsi/ginkgo" | ||
. "github.com/onsi/gomega" | ||
"time" | ||
) | ||
|
||
var _ = Describe("Platforms Indicator", func() { | ||
var indicator health.Indicator | ||
var repository *storagefakes2.FakeStorage | ||
var ctx context.Context | ||
var platform *types.Platform | ||
|
||
BeforeEach(func() { | ||
ctx = context.TODO() | ||
repository = &storagefakes2.FakeStorage{} | ||
platform = &types.Platform{ | ||
Name: "test-platform", | ||
Type: "kubernetes", | ||
Active: false, | ||
LastActive: time.Now(), | ||
} | ||
indicator = NewPlatformIndicator(ctx, repository, nil) | ||
}) | ||
|
||
Context("Name", func() { | ||
It("should not be empty", func() { | ||
Expect(indicator.Name()).Should(Equal(health.PlatformsIndicatorName)) | ||
}) | ||
}) | ||
|
||
Context("There are inactive platforms", func() { | ||
BeforeEach(func() { | ||
objectList := &types.Platforms{[]*types.Platform{platform}} | ||
repository.ListReturns(objectList, nil) | ||
}) | ||
It("should return error", func() { | ||
details, err := indicator.Status() | ||
health := details.(map[string]*health.Health)[platform.Name] | ||
Expect(err).Should(HaveOccurred()) | ||
Expect(health.Details["since"]).ShouldNot(BeNil()) | ||
}) | ||
}) | ||
|
||
Context("Storage returns error", func() { | ||
var expectedErr error | ||
BeforeEach(func() { | ||
expectedErr = errors.New("storage err") | ||
repository.ListReturns(nil, expectedErr) | ||
}) | ||
It("should return error", func() { | ||
_, err := indicator.Status() | ||
Expect(err).Should(HaveOccurred()) | ||
Expect(err.Error()).To(ContainSubstring(expectedErr.Error())) | ||
}) | ||
}) | ||
|
||
Context("All platforms are active", func() { | ||
BeforeEach(func() { | ||
platform.Active = true | ||
objectList := &types.Platforms{[]*types.Platform{platform}} | ||
repository.ListReturns(objectList, nil) | ||
}) | ||
It("should not return error", func() { | ||
_, err := indicator.Status() | ||
Expect(err).ShouldNot(HaveOccurred()) | ||
}) | ||
}) | ||
}) |
Oops, something went wrong.