fix(siren): provider plugin interface (#30)

* fix: add better logging for plugins provider (#29) * feat: bump up go
goto · Sep 25, 2023 · cd90feb · cd90feb
1 parent 48505b2
commit cd90feb
Show file tree

Hide file tree

Showing 40 changed files with 511 additions and 1,635 deletions.
diff --git a/.github/workflows/e2e_test.yaml b/.github/workflows/e2e_test.yaml
@@ -18,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.21
       - name: Install dependencies
         run: go mod tidy
       - name: Test end-to-end

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -1,5 +1,5 @@
 name: Lint
-on: [ push, pull_request, workflow_dispatch ]
+on: [push, workflow_dispatch]
 
 jobs:
   golangci-lint:
@@ -8,10 +8,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.21
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
           skip-go-installation: true
-          version: v1.50.1
-          args: --timeout=10m
+          version: v1.54.2
+          args: --timeout=10m
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -22,7 +22,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.21
         id: go
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2

diff --git a/.github/workflows/release_cortex_provider_plugin.yaml b/.github/workflows/release_cortex_provider_plugin.yaml
@@ -10,7 +10,7 @@ jobs:
       - name: Set up Go 1.x
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.21
         id: go
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,6 +1,5 @@
-
 name: Test
-on: [push, pull_request]
+on: [push]
 
 jobs:
   test:
@@ -20,10 +19,10 @@ jobs:
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2
-      - name: Set up Go 1.18
+      - name: Set up Go 1.21
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.21
         id: go
       - name: Install dependencies
         run: sudo apt-get install build-essential

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Explore the following resources to get started with Siren:
 Siren requires the following dependencies:
 
 - Docker
-- Golang (version 1.18 or above)
+- Golang (version 1.21 or above)
 - Git
 
 Run the application dependencies using Docker:

diff --git a/cli/deps.go b/cli/deps.go
@@ -73,9 +73,6 @@ func InitDeps(
 	templateRepository := postgres.NewTemplateRepository(pgClient)
 	templateService := template.NewService(templateRepository)
 
-	providerRepository := postgres.NewProviderRepository(pgClient)
-	providerService := provider.NewService(providerRepository)
-
 	logRepository := postgres.NewLogRepository(pgClient)
 	logService := log.NewService(logRepository)
 
@@ -89,6 +86,13 @@ func InitDeps(
 		return nil, nil, nil, nil, nil, err
 	}
 
+	var supportedProviderTypes = []string{}
+	for typ := range providerPlugins {
+		supportedProviderTypes = append(supportedProviderTypes, typ)
+	}
+	providerRepository := postgres.NewProviderRepository(pgClient)
+	providerService := provider.NewService(providerRepository, supportedProviderTypes)
+
 	var configSyncers = make(map[string]namespace.ConfigSyncer, 0)
 	var alertTransformers = make(map[string]alert.AlertTransformer, 0)
 	var ruleUploaders = make(map[string]rule.RuleUploader, 0)

diff --git a/core/alert/service_test.go b/core/alert/service_test.go
@@ -26,7 +26,7 @@ func TestService_List(t *testing.T) {
 			{ID: 2, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "baz", MetricValue: "0",
 				Rule: "bar", TriggeredAt: timenow},
 		}
-		repositoryMock.EXPECT().List(mock.AnythingOfType("*context.emptyCtx"), alert.Filter{
+		repositoryMock.EXPECT().List(mock.AnythingOfType("context.todoCtx"), alert.Filter{
 			ProviderID:   1,
 			ResourceName: "foo",
 			StartTime:    0,
@@ -53,7 +53,7 @@ func TestService_List(t *testing.T) {
 			{ID: 2, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "baz", MetricValue: "0",
 				Rule: "bar", TriggeredAt: timenow},
 		}
-		repositoryMock.EXPECT().List(mock.AnythingOfType("*context.emptyCtx"), mock.Anything).Return(dummyAlerts, nil)
+		repositoryMock.EXPECT().List(mock.AnythingOfType("context.todoCtx"), mock.Anything).Return(dummyAlerts, nil)
 		actualAlerts, err := dummyService.List(ctx, alert.Filter{
 			ProviderID:   1,
 			ResourceName: "foo",
@@ -68,7 +68,7 @@ func TestService_List(t *testing.T) {
 	t.Run("should call repository List method and handle errors", func(t *testing.T) {
 		repositoryMock := &mocks.AlertRepository{}
 		dummyService := alert.NewService(repositoryMock, nil, nil)
-		repositoryMock.EXPECT().List(mock.AnythingOfType("*context.emptyCtx"), mock.Anything).
+		repositoryMock.EXPECT().List(mock.AnythingOfType("context.todoCtx"), mock.Anything).
 			Return(nil, errors.New("random error"))
 		actualAlerts, err := dummyService.List(ctx, alert.Filter{
 			ProviderID:   1,
@@ -116,19 +116,19 @@ func TestService_CreateAlerts(t *testing.T) {
 		{
 			name: "should return error if TransformToAlerts return error",
 			setup: func(ar *mocks.AlertRepository, at *mocks.AlertTransformer) {
-				at.EXPECT().TransformToAlerts(mock.AnythingOfType("*context.emptyCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return(nil, 0, errors.New("some error"))
+				at.EXPECT().TransformToAlerts(mock.AnythingOfType("context.todoCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return(nil, 0, errors.New("some error"))
 			},
 			alertsToBeCreated: alertsToBeCreated,
 			wantErr:           true,
 		},
 		{
 			name: "should call repository Create method with proper arguments",
 			setup: func(ar *mocks.AlertRepository, at *mocks.AlertTransformer) {
-				at.EXPECT().TransformToAlerts(mock.AnythingOfType("*context.emptyCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
+				at.EXPECT().TransformToAlerts(mock.AnythingOfType("context.todoCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
 					{ID: 1, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "lag", MetricValue: "20",
 						Rule: "lagHigh", TriggeredAt: timenow},
 				}, 1, nil)
-				ar.EXPECT().Create(mock.AnythingOfType("*context.emptyCtx"), mock.AnythingOfType("alert.Alert")).Return(alert.Alert{ID: 1, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "lag", MetricValue: "20",
+				ar.EXPECT().Create(mock.AnythingOfType("context.todoCtx"), mock.AnythingOfType("alert.Alert")).Return(alert.Alert{ID: 1, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "lag", MetricValue: "20",
 					Rule: "lagHigh", TriggeredAt: timenow}, nil)
 			},
 			alertsToBeCreated: alertsToBeCreated,
@@ -141,23 +141,23 @@ func TestService_CreateAlerts(t *testing.T) {
 		{
 			name: "should return error not found if repository return err relation",
 			setup: func(ar *mocks.AlertRepository, at *mocks.AlertTransformer) {
-				at.EXPECT().TransformToAlerts(mock.AnythingOfType("*context.emptyCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
+				at.EXPECT().TransformToAlerts(mock.AnythingOfType("context.todoCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
 					{ID: 1, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "lag", MetricValue: "20",
 						Rule: "lagHigh", TriggeredAt: timenow},
 				}, 1, nil)
-				ar.EXPECT().Create(mock.AnythingOfType("*context.emptyCtx"), mock.Anything).Return(alert.Alert{}, alert.ErrRelation)
+				ar.EXPECT().Create(mock.AnythingOfType("context.todoCtx"), mock.Anything).Return(alert.Alert{}, alert.ErrRelation)
 			},
 			alertsToBeCreated: alertsToBeCreated,
 			wantErr:           true,
 		},
 		{
 			name: "should handle errors from repository",
 			setup: func(ar *mocks.AlertRepository, at *mocks.AlertTransformer) {
-				at.EXPECT().TransformToAlerts(mock.AnythingOfType("*context.emptyCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
+				at.EXPECT().TransformToAlerts(mock.AnythingOfType("context.todoCtx"), mock.AnythingOfType("uint64"), mock.AnythingOfType("uint64"), mock.AnythingOfType("map[string]interface {}")).Return([]alert.Alert{
 					{ID: 1, ProviderID: 1, ResourceName: "foo", Severity: "CRITICAL", MetricName: "lag", MetricValue: "20",
 						Rule: "lagHigh", TriggeredAt: timenow},
 				}, 1, nil)
-				ar.EXPECT().Create(mock.AnythingOfType("*context.emptyCtx"), mock.Anything).Return(alert.Alert{}, errors.New("random error"))
+				ar.EXPECT().Create(mock.AnythingOfType("context.todoCtx"), mock.Anything).Return(alert.Alert{}, errors.New("random error"))
 			},
 			alertsToBeCreated: alertsToBeCreated,
 			wantErr:           true,