Copyonwrite/248/add devcontainer setup

.devcontainer/Dockerfile

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+# SPDX-License-Identifier: Apache-2.0
+
+FROM mcr.microsoft.com/devcontainers/go
+
+WORKDIR /go/src/github.com/cloudoperators/heureka
+ADD . .

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+	"name": "heureka & MariaDB",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "app",
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+	"postCreateCommand": "make",
+        "forwardPorts": [
+           80,
+           "mariadb:3306"
+        ]
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+# SPDX-License-Identifier: Apache-2.0
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+      - ../internal/database/mariadb/init/schema.sql:/app_sqlschema/schema.sql
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:mariadb
+
+    environment:
+      # MariaDB Connection
+      DB_ADDRESS: mariadb
+      DB_PORT: 3306
+      DB_USER: mariadb
+      DB_PASSWORD: mariadb
+      DB_ROOT_PASSWORD: mariadb
+      DB_NAME: heureka
+      DB_SCHEMA: /app_sqlschema/schema.sql
+
+
+      SEED_MODE: "true"
+
+  mariadb:
+    image: mariadb:latest
+    container_name: mariadb
+    restart: unless-stopped
+
+    environment:
+      MARIADB_USER: mariadb
+      MARIADB_PASSWORD: mariadb
+      MARIADB_DATABASE: heureka
+      MARIADB_ROOT_PASSWORD: mariadb
+
+    volumes:
+      - ../.mariadb-dev/:/var/lib/mysql

.env-devcontainer

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+# SPDX-License-Identifier: Apache-2.0
+
+DB_USER=mariadb
+DB_PASSWORD=mariadb
+DB_ROOT_PASSWORD=mariadb
+DB_NAME=heureka
+DB_ADDRESS=mariadb
+DB_PORT=3306
+DB_SCHEMA=internal/database/mariadb/init/schema.sql
+
+DB_CONTAINER_IMAGE=mariadb:latest
+
+LOG_PRETTY_PRINT=true
+
+LOCAL_TEST_DB=true
+
+SEED_MODE=true

.gitignore

@@ -21,8 +21,10 @@
 # vendor/
 .vscode
 .DS_Store
+cmd/heureka/__debug_bin*
 
 # Heureka specifics
 build/
 .db/
-.env
+.env
+.mariadb-dev/

.testenv-devcontainer

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+# SPDX-License-Identifier: Apache-2.0
+
+LOCAL_TEST_DB=true
+
+DB_USER=mariadb
+DB_PASSWORD=mariadb
+DB_ROOT_PASSWORD=mariadb
+DB_NAME=heureka
+DB_ADDRESS=mariadb
+DB_PORT=3306
+DB_SCHEMA=internal/database/mariadb/init/schema.sql
+
+LOG_PRETTY_PRINT=true
+
+SEED_MODE=false

.vscode/launch.json

@@ -0,0 +1,49 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch K8sScanner",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "cwd": "${workspaceFolder}",
+            "program": "scanner/k8s-assets/main.go",
+            "envFile": "${workspaceFolder}/scanner/k8s-assets/.env"
+        },
+        {
+            "name": "Launch NvdScanner",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "cwd": "${workspaceFolder}",
+            "program": "scanner/nvd/main.go",
+            "envFile": "${workspaceFolder}/scanner/nvd/.env"
+        },
+        {
+            "name": "Launch KeppelScanner",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "cwd": "${workspaceFolder}",
+            "program": "scanner/keppel/main.go",
+            "envFile": "${workspaceFolder}/scanner/keppel/.env"
+        },
+        {
+            "name": "Launch Heureka DevContainer",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "cmd/heureka/main.go",
+            "args": [
+                "-mode",
+                "seed"
+            ],
+            "cwd": "${workspaceFolder}",
+            "envFile": "${workspaceFolder}/.env-devcontainer",
+            "showLog": true
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "go.testEnvFile": "${workspaceFolder}/.testenv-devcontainer"
+}

README.md

@@ -87,12 +87,37 @@ docker-compose --profile db --profile heureka up
 
 ### Makefile
 
-Alternatively, the application can be started by using the provided Makefile:
+The application can be started by using the provided Makefile:
 
 ```
 make start-all-heureka
 ```
 
+### Devcontainers
+
+Devcontainers is a new standard for development environments based on (docker)
+[devcontainer](./.devcontainer).
+
+At the moment devcontainers are supported by Visual Studio Code and IDEA IDEs.
+
+For Microsoft Visual Studio code, install the remote container extension via
+Ctrl-P and this command:
+
+        ext install ms-vscode-remote.remote-containers
+
+When opening the root folder in Visual Studio code a prompt will ask you to
+open the project in a dev container, which you should.
+
+Once inside the devcontainer the provided launch.json is configured to allow
+launching heureka and running the unit and integration tests.
+
+At the moment there is a known issue with the permissions of the .mariadb-dev
+folder. This folder has to be deleted every time after using the devcontainers.
+Use the following command in the root folder of heureka:
+
+    sudo rm -rf .mariadb-dev
+
+
 ### Tests
 
 #### Mockery

internal/api/graphql/access/token_auth_test.go

@@ -57,11 +57,7 @@ func (s *server) startInBackground(port string) {
 	s.ctx, s.cancel = context.WithCancel(context.Background())
 
 	s.srv = &http.Server{Addr: fmt.Sprintf(":%s", port), Handler: r}
-	go func() {
-		if err := s.srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
-			fmt.Println("Unexpected error when running test server")
-		}
-	}()
+	util2.FirstListenThenServe(s.srv)
 }
 
 func (s *server) stop() {

internal/server/server.go

@@ -12,11 +12,11 @@ import (
 	"syscall"
 	"time"
 
+	graphqlapi "github.com/cloudoperators/heureka/internal/api/graphql"
 	"github.com/cloudoperators/heureka/internal/app"
 	"github.com/cloudoperators/heureka/internal/database/mariadb"
-
-	graphqlapi "github.com/cloudoperators/heureka/internal/api/graphql"
 	"github.com/cloudoperators/heureka/internal/util"
+	util2 "github.com/cloudoperators/heureka/pkg/util"
 	"github.com/onuryilmaz/ginprom"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/sirupsen/logrus"
@@ -145,12 +145,7 @@ func (s *Server) NonBlockingStart() {
 		Handler: s.router.Handler(),
 	}
 
-	go func() {
-		logrus.Info("Starting Non Blocking HTTP Server...")
-		if err := s.nonBlockingSrv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
-			logrus.WithError(err).Fatalf("Error while serving HTTP Server.")
-		}
-	}()
+	util2.FirstListenThenServe(s.nonBlockingSrv)
 }
 
 func (s *Server) BlockingStop() {
@@ -164,6 +159,7 @@ func (s *Server) BlockingStop() {
 		log.Fatalf("Error while shuting down Heureka App: %s", err)
 	}
 }
+
 func (s *Server) NonBlockingStop() {
 	ctx := *s.nonBlockingCtx
 	stop := *s.nonBlockingStop

internal/util/config.go

@@ -33,7 +33,7 @@ type Config struct {
 	//// https://pkg.go.dev/github.com/robfig/cron#hdr-Predefined_schedules
 	//DiscoverySchedule string `envconfig:"DISOVERY_SCHEDULE" default:"0 0 0 * * *" json:"discoverySchedule"`
 	SeedMode              bool   `envconfig:"SEED_MODE" required:"false" default:"false" json:"seedMode"`
-	AuthType              string `envconfig:"AUTH_TYPE" required:"false" json:"-"`
+	AuthType              string `envconfig:"AUTH_TYPE" required:"false" json:"-" default:"none"`
 	AuthTokenSecret       string `envconfig:"AUTH_TOKEN_SECRET" required:"false" json:"-"`
 	DefaultIssuePriority  int64  `envconfig:"DEFAULT_ISSUE_PRIORITY" default:"100" json:"defaultIssuePriority"`
 	DefaultRepositoryName string `envconfig:"DEFAULT_REPOSITORY_NAME" default:"nvd" json:"defaultRepositoryName"`

pkg/util/server.go

@@ -0,0 +1,33 @@
+// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Greenhouse contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package util
+
+import (
+	"net"
+	"net/http"
+	"sync"
+
+	"github.com/sirupsen/logrus"
+)
+
+// FirstListenThenServe is a utility function that ensures that first a listener is spin up then the http server is setup for serving asynchronously
+// this is requried to ensure in tests that the server is spinned up before jumping to tests.
+func FirstListenThenServe(srv *http.Server) {
+	var waitGroup sync.WaitGroup
+	waitGroup.Add(1)
+	go func() {
+		logrus.Info("Starting Non Blocking HTTP Server...")
+		ln, err := net.Listen("tcp", srv.Addr)
+		if err != nil {
+			logrus.WithError(err).Fatalf("Error while start listening...")
+		}
+		go func() {
+			waitGroup.Done()
+		}()
+		if err := srv.Serve(ln); err != nil && err != http.ErrServerClosed {
+			logrus.WithError(err).Fatalf("Error while serving HTTP Server.")
+		}
+	}()
+	waitGroup.Wait()
+}