ADD recommended flag to plugin index

kubeshop · Dec 18, 2023 · f673374 · f673374
1 parent 2955f95
commit f673374
Show file tree

Hide file tree

Showing 19 changed files with 128 additions and 82 deletions.
diff --git a/internal/executor/doctor/executor.go b/internal/executor/doctor/executor.go
@@ -67,6 +67,7 @@ func (d *Executor) Metadata(context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/internal/executor/flux/executor.go b/internal/executor/flux/executor.go
@@ -53,6 +53,7 @@ func (d *Executor) Metadata(context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/internal/executor/helm/executor.go b/internal/executor/helm/executor.go
@@ -76,6 +76,7 @@ func (e *Executor) Metadata(context.Context) (api.MetadataOutput, error) {
 				URLs: helmBinaryDownloadLinks,
 			},
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/internal/executor/kubectl/executor.go b/internal/executor/kubectl/executor.go
@@ -78,6 +78,7 @@ func (e *Executor) Metadata(context.Context) (api.MetadataOutput, error) {
 				URLs: kcBinaryDownloadLinks,
 			},
 		},
+		Recommended: true,
 	}, nil
 }
 

diff --git a/internal/plugin/index.go b/internal/plugin/index.go
@@ -53,6 +53,7 @@ type (
 		URLs             []IndexURL      `yaml:"urls"`
 		JSONSchema       JSONSchema      `yaml:"jsonSchema"`
 		ExternalRequest  ExternalRequest `yaml:"externalRequest,omitempty"`
+		Recommended      bool            `yaml:"recommended"`
 	}
 
 	// ExternalRequest contains the external request metadata for a given plugin.

diff --git a/internal/plugin/index_builder.go b/internal/plugin/index_builder.go
@@ -102,6 +102,7 @@ func (i *IndexBuilder) Build(dir, urlBasePath, pluginNameFilter string, skipChec
 					},
 				},
 			},
+			Recommended: meta.Recommended,
 		})
 	}
 

diff --git a/internal/plugin/store.go b/internal/plugin/store.go
@@ -27,6 +27,7 @@ type (
 		URLs             map[string]URL
 		Dependencies     map[string]map[string]string
 		JSONSchema       JSONSchema
+		Recommended      bool
 	}
 
 	URL struct {
@@ -102,6 +103,7 @@ func newStoreRepositories(indexes map[string][]byte) (storeRepository, storeRepo
 					URLs:             binURLs,
 					Dependencies:     depURLs,
 					JSONSchema:       entry.JSONSchema,
+					Recommended:      entry.Recommended,
 				})
 			case TypeSource:
 				sourcesRepositories.Insert(repo, entry.Name, storeEntry{
@@ -111,6 +113,7 @@ func newStoreRepositories(indexes map[string][]byte) (storeRepository, storeRepo
 					URLs:             binURLs,
 					Dependencies:     depURLs,
 					JSONSchema:       entry.JSONSchema,
+					Recommended:      entry.Recommended,
 				})
 			}
 		}

diff --git a/internal/source/argocd/argocd.go b/internal/source/argocd/argocd.go
@@ -182,6 +182,7 @@ func (s *Source) Metadata(_ context.Context) (api.MetadataOutput, error) {
 				},
 			},
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/internal/source/github_events/source_grpc.go b/internal/source/github_events/source_grpc.go
@@ -75,5 +75,6 @@ func (s *Source) Metadata(_ context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: false,
 	}, nil
 }
diff --git a/internal/source/keptn/source.go b/internal/source/keptn/source.go
@@ -64,6 +64,7 @@ func (p *Source) Metadata(_ context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/internal/source/kubernetes/source.go b/internal/source/kubernetes/source.go
@@ -111,6 +111,7 @@ func (s *Source) Metadata(_ context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: true,
 	}, nil
 }
 

diff --git a/internal/source/prometheus/source.go b/internal/source/prometheus/source.go
@@ -66,6 +66,7 @@ func (p *Source) Metadata(_ context.Context) (api.MetadataOutput, error) {
 		JSONSchema: api.JSONSchema{
 			Value: configJSONSchema,
 		},
+		Recommended: false,
 	}, nil
 }
 

diff --git a/pkg/api/executor/executor.pb.go b/pkg/api/executor/executor.pb.go
diff --git a/pkg/api/executor/grpc_adapter.go b/pkg/api/executor/grpc_adapter.go
@@ -204,6 +204,7 @@ func (p *grpcClient) Metadata(ctx context.Context) (api.MetadataOutput, error) {
 			RefURL: resp.GetJsonSchema().GetRefUrl(),
 		},
 		Dependencies: api.ConvertDependenciesToAPI(resp.Dependencies),
+		Recommended:  resp.Recommended,
 	}, nil
 }
 
@@ -300,6 +301,7 @@ func (p *grpcServer) Metadata(ctx context.Context, _ *emptypb.Empty) (*MetadataR
 			RefUrl: meta.JSONSchema.RefURL,
 		},
 		Dependencies: api.ConvertDependenciesFromAPI[*Dependency, Dependency](meta.Dependencies),
+		Recommended:  meta.Recommended,
 	}, nil
 }
 

diff --git a/pkg/api/plugin.go b/pkg/api/plugin.go
@@ -31,6 +31,8 @@ type MetadataOutput struct {
 
 	// Dependencies holds the dependencies for a given platform binary.
 	Dependencies map[string]Dependency
+	// Recommended says if plugin is recommended
+	Recommended bool
 }
 
 // ExternalRequestMetadata contains the metadata for external requests.

diff --git a/pkg/api/source/grpc_adapter.go b/pkg/api/source/grpc_adapter.go
@@ -247,6 +247,7 @@ func (p *grpcClient) Metadata(ctx context.Context) (api.MetadataOutput, error) {
 		},
 		ExternalRequest: externalRequest,
 		Dependencies:    api.ConvertDependenciesToAPI(resp.Dependencies),
+		Recommended:     resp.Recommended,
 	}, nil
 }
 
@@ -277,6 +278,7 @@ func (p *grpcServer) Metadata(ctx context.Context, _ *emptypb.Empty) (*MetadataR
 			},
 		},
 		Dependencies: api.ConvertDependenciesFromAPI[*Dependency, Dependency](meta.Dependencies),
+		Recommended:  meta.Recommended,
 	}, nil
 }
-Original file line number
+Diff line change
@@ Expand Up @@
     		JSONSchema: api.JSONSchema{
     			Value: configJSONSchema,
     		},
+    		Recommended: false,
     	}, nil
     }
@@ Expand Down @@