Enable publicapi to run on CF #3119

bonzofenix · 2024-08-06T16:10:43Z

No description provided.

…rder • Removed metricsforwarder and metricsforwarder.yml from .gitignore. • Changed health check configuration keys to nest under BasicAuth and ServerConfig. • Updated tests to reflect configuration changes and removed unused code. • Fixed request creation in tests to use dynamic server URL and proper basic auth setup.

…e server and tests • Add generate.go for autoscaler API generation • Create ogen-config.yaml to allow remote parser configuration • Introduce security.go with SecuritySource struct • Refactor main.go to remove Prometheus and health endpoint dependencies • Update scalingengine_suite_test.go and scalingengine_test.go to reflect new health server configuration and client creation • Modify config_test.go and valid.yml to adjust health server port configuration • Implement scaling_history_handler.go without bearer auth for internal mTLS use • Adjust scaling_history_handler_test.go to use new package path • Overhaul server.go to separate health and mTLS server creation, and to streamline router setup • Amend server_test.go to align with server refactoring and use dynamic URL construction

• Removed scalingEngineClient from PublicApiHandler and associated creation logic. • Replaced CreateHTTPClient with CreateHTTPSClient for eventGeneratorClient. • Deleted GetScalingHistories function as it's no longer needed. • Refactored NewPublicApiServer to use a new PublicApiServer struct and split into GetHealthServer and GetMtlsServer methods. • Updated import paths and variable names to reflect internal scaling history API changes. • Added SecuritySource struct to handle security for scaling history handler. • Modified ScalingHistoryHandler to use the new internal scaling history client and updated JSON marshaling logic.

• Update API test suite to use testhelpers package for utility functions. • Modify health check configuration to use BasicAuth struct instead of separate username and password fields. • Remove unused variables and imports, and clean up test setup for clarity. • Adjust API server creation to directly instantiate servers without a separate function.

…ort config, and switch to HTTPS client in schedulerclient

• Add a new Makefile for the eventgenerator component with a fetch-config target to pull configuration and certificates from the metricsforwarder VM. • Refactor eventgenerator test suites to improve readability and organization, including the use of When blocks for context-specific conditions. • Update eventgenerator REST API tests to use helper functions for creating HTTP clients and constructing request URLs. • Modify the eventgenerator main.go to use a new server creation function that handles both MTLS and health endpoints. • Adjust eventgenerator configuration tests to reflect changes in the health check server configuration structure. • Implement server.go changes to separate the creation of the event generator and health routers, and to provide functions for retrieving MTLS and health servers. • Update server_suite_test.go to remove unnecessary setup code due to refactoring. • Refactor server_test.go to use the new server creation functions and to organize tests into When and Describe blocks for clarity.

…reation • Replace individual HealthCheckUsername and HealthCheckPassword fields with a BasicAuth struct in HealthConfig. • Update validation logic in HealthConfig to work with the new BasicAuth fields. • Modify tests to reflect changes in HealthConfig structure. • Implement TransportWithBasicAuth to add basic authentication headers to HTTP requests. • Adjust CreateHTTPClient function to accept BasicAuth and use TransportWithBasicAuth. • Add BasicAuth struct to models package to encapsulate basic authentication data.

• Rename HealthCheckUsername and related fields to BasicAuth struct fields • Update health readiness tests to use new BasicAuth struct fields • Remove basic auth middleware implementation from server.go • Simplify health router creation by using helpers.CreateBasicAuthMiddleware

- Replace direct Prometheus registry creation with `createPrometheusRegistry` function. - Change `CreateHTTPClient` to `CreateHTTPSClient` for both scaling engine and scheduler clients. - Update health endpoint creation to use `NewHealthRouter` and `NewHTTPServer`. - Adjust health check configuration structure in tests and sample config.

• Implement BasicAuthenticationMiddleware with bcrypt password hashing • Create middleware to protect healthcheck endpoint using basic auth • Add unit tests for BasicAuthenticationMiddleware with correct and incorrect credentials

- Move scaling history OpenAPI generation from helpers to api and scalingengine directories - Add new internal-scaling-history-api.openapi.yaml for Scaling History API - Update Makefile to handle OpenAPI client and server generation in new locations - Add NewScalingEngineClient function in testhelpers

src/autoscaler/api/cmd/api/api_suite_test.go

github-actions · 2024-08-07T12:50:08Z

src/autoscaler/scalingengine/server/server.go


-	return helpers.NewHTTPServer(logger, conf.Server, r)
+func setupMainRouter(r *mux.Router, healthRouter *mux.Router) *mux.Router {


🚫 [golangci] _{reported by reviewdog 🐶}
func setupMainRouter is unused (unused)

github-actions · 2024-08-07T12:50:08Z

src/autoscaler/eventgenerator/server/server.go


-	return helpers.NewHTTPServer(logger, httpServerConfig, r)
+func setupMainRouter(egRouter, healthRouter *mux.Router) *mux.Router {


🚫 [golangci] _{reported by reviewdog 🐶}
func setupMainRouter is unused (unused)

github-actions · 2024-08-07T12:50:08Z

src/autoscaler/helpers/auth/xfcc_auth.go

+
+	return nil
+
+}


🚫 [golangci] _{reported by reviewdog 🐶}
unnecessary trailing newline (whitespace)

src/autoscaler/helpers/auth/xfcc_auth.go

src/autoscaler/api/publicapiserver/scaling_history_handler.go

github-actions · 2024-08-07T12:50:09Z

src/autoscaler/eventgenerator/server/server.go

+	httpStatusCollector healthendpoint.HTTPStatusCollector
+}
+
+func (s *Server) GetMtlsServer() (ifrit.Runner, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unnecessary leading newline (whitespace)

src/autoscaler/eventgenerator/server/server.go

src/autoscaler/api/cmd/api/api_test.go

sonarcloud · 2024-08-29T15:25:03Z

Quality Gate failed

Failed conditions
3.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

…I server

…n autoscaler API

src/autoscaler/helpers/httpclient.go

+func (t *TransportWithBasicAuth) RoundTrip(req *http.Request) (*http.Response, error) {
+	credentials := t.Username + ":" + t.Password
+	basicAuth := "Basic " + base64.StdEncoding.EncodeToString([]byte(credentials))
+	fmt.Println("banana TransportWithBasicAuth:credentials", credentials)


To fix the problem, we need to remove the logging of sensitive information. Specifically, we should remove the lines that print the credentials and basicAuth strings. This will ensure that sensitive information is not logged in clear text.

Remove the logging statements that print the credentials and basicAuth strings.

Ensure that no sensitive information is logged in clear text.

…gine servers

Improve error logging in metric_poller_test and update health port configuration structure configuration in both config_test.go and exampleconfig/config.yml.

sonarcloud · 2024-10-11T12:01:44Z

Quality Gate failed

Failed conditions
3.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

bonzofenix force-pushed the 754-publicapi-in-cf branch 4 times, most recently from a1186d0 to cee86b5 Compare August 7, 2024 08:16

bonzofenix added 12 commits August 7, 2024 14:36

Add go:generate directive and remote parsing to ogen, update health p…

a45b9c5

…ort config, and switch to HTTPS client in schedulerclient

WIP - xfcc middleware for publicapi

31ddfbb

bonzofenix force-pushed the 754-publicapi-in-cf branch from cee86b5 to 31ddfbb Compare August 7, 2024 12:43

github-actions bot reviewed Aug 7, 2024

View reviewed changes

Merge branch 'main' into 754-publicapi-in-cf

cef43b9

bonzofenix and others added 8 commits October 10, 2024 11:37

Merge branch 'main' into 754-publicapi-in-cf

2103d1f

Merge debox

25b355a

Remove API credential routes and associated middleware from public AP…

f0bb44a

…I server

Remove unused net/http import and apiHttpClient from api_suite_test i…

f385475

…n autoscaler API

Fix lint

817c1de

Small fix

c5f8138

Remove Health Port configuration from metricsforwarder tests

4b10025

Fix lint

b8bdaed

github-advanced-security bot found potential problems Oct 10, 2024

View reviewed changes

Comment out setupMainRouter functions in eventgenerator and scalingen…

288606f

…gine servers

Fix test

167ec9c

Improve error logging in metric_poller_test and update health port configuration structure configuration in both config_test.go and exampleconfig/config.yml.

@@ -32,4 +32,4 @@
             	basicAuth := "Basic " + base64.StdEncoding.EncodeToString([]byte(credentials))
-            	fmt.Println("banana TransportWithBasicAuth:credentials", credentials)
-            	fmt.Println("banana TransportWithBasicAuth:", basicAuth)
+            	// fmt.Println("banana TransportWithBasicAuth:credentials", credentials)
+            	// fmt.Println("banana TransportWithBasicAuth:", basicAuth)
             	req.Header.Add("Authorization", basicAuth)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable publicapi to run on CF #3119

Enable publicapi to run on CF #3119

bonzofenix commented Aug 6, 2024

github-actions bot Aug 7, 2024

github-actions bot Aug 7, 2024

github-actions bot Aug 7, 2024

github-actions bot Aug 7, 2024

sonarcloud bot commented Aug 29, 2024

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

sonarcloud bot commented Oct 11, 2024


		return helpers.NewHTTPServer(logger, conf.Server, r)
		func setupMainRouter(r mux.Router, healthRouter mux.Router) *mux.Router {


		return helpers.NewHTTPServer(logger, httpServerConfig, r)
		func setupMainRouter(egRouter, healthRouter mux.Router) mux.Router {

Enable publicapi to run on CF #3119

Are you sure you want to change the base?

Enable publicapi to run on CF #3119

Conversation

bonzofenix commented Aug 6, 2024

github-actions bot Aug 7, 2024

Choose a reason for hiding this comment

github-actions bot Aug 7, 2024

Choose a reason for hiding this comment

github-actions bot Aug 7, 2024

Choose a reason for hiding this comment

github-actions bot Aug 7, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Aug 29, 2024

Quality Gate failed

sonarcloud bot commented Oct 11, 2024

Quality Gate failed