feat: Add SonarQube for code coverage

Author: patrickkenney9801

.pre-commit-config.yaml

@@ -46,6 +46,9 @@ repos:
         exclude: server/internal/pbs
       - id: go-imports
         exclude: server/internal/pbs
+      - id: go-vet
+        language: system
+        entry: bash -c "cd server && go vet ./..."
       - id: golangci-lint
         language: system
         entry: bash -c "cd server && golangci-lint run"

Makefile

@@ -24,15 +24,23 @@ define grafana_port
 $(shell kubectl --context ${PROFILE} get --namespace grafana -o jsonpath="{.spec.ports[0].nodePort}" services grafana)
 endef
 
+define sonar_ip
+$(shell kubectl --context ${PROFILE} get nodes --namespace sonarqube -o jsonpath="{.items[0].status.addresses[0].address}")
+endef
+
+define sonar_port
+$(shell kubectl --context ${PROFILE} get --namespace sonarqube -o jsonpath="{.spec.ports[0].nodePort}" services sonarqube-sonarqube)
+endef
+
 image-client:
 	@docker build --build-arg VERSION=${VERSION} -t ${IMAGE_NAME}:${VERSION} --file client.Dockerfile .
 
 image-server:
 	@docker build --build-arg VERSION=${VERSION} -t ${SERVER_IMAGE_NAME}:${VERSION} --file server.Dockerfile .
 
 image-test-server:
-	@docker build --build-arg VERSION=${VERSION} -t ${SERVER_IMAGE_NAME}-test:${VERSION} --file server.Dockerfile --target go-test .
-	@docker run --rm ${SERVER_IMAGE_NAME}-test:${VERSION}
+	@docker build --build-arg VERSION=${VERSION} --build-arg SONAR_ADDRESS=http://$(call sonar_ip):$(call sonar_port) -t ${SERVER_IMAGE_NAME}-test:${VERSION} --file server.Dockerfile --target go-test .
+	@docker run --rm --net=host ${SERVER_IMAGE_NAME}-test:${VERSION}
 
 image-client-debug:
 	@docker build --build-arg VERSION=${VERSION} -t ${IMAGE_NAME}-debug:${VERSION} --file client.Dockerfile --target mvn-build .
@@ -70,7 +78,8 @@ observability-minikube:
 	@helm --kube-context ${PROFILE} -n fluent install --create-namespace fluent-bit fluent/fluent-bit --version=0.29.0 -f observability/fluentbit_values.yaml --wait || true
 	@helm --kube-context ${PROFILE} -n tempo install --create-namespace tempo grafana/tempo --version=1.0.0 -f observability/tempo_values.yaml --wait || true
 	@helm --kube-context ${PROFILE} -n monitoring install --create-namespace kube-prometheus-stack prometheus/kube-prometheus-stack --version=45.23.0 -f observability/prometheus_values.yaml --wait || true
-	@helm --kube-context ${PROFILE} -n grafana install --create-namespace grafana grafana/grafana --version=6.50.7 -f observability/grafana_values.yaml --wait
+	@helm --kube-context ${PROFILE} -n grafana install --create-namespace grafana grafana/grafana --version=6.50.7 -f observability/grafana_values.yaml --wait || true
+	@helm --kube-context ${PROFILE} -n sonarqube install --create-namespace sonarqube sonarqube/sonarqube --version=10.0.0 -f observability/sonarqube_values.yaml --wait || true
 
 clean-observability-minikube:
 	@helm --kube-context ${PROFILE} -n elasticsearch delete elasticsearch --wait
@@ -85,10 +94,17 @@ clean-fluent:
 clean-grafana:
 	@helm --kube-context ${PROFILE} -n grafana delete grafana --wait
 
+clean-sonar:
+	@helm --kube-context ${PROFILE} -n sonarqube delete sonarqube --wait
+
 grafana:
 	@echo http://$(call grafana_ip):$(call grafana_port)
 	@python -mwebbrowser http://$(call grafana_ip):$(call grafana_port)
 
+sonar:
+	@echo http://$(call sonar_ip):$(call sonar_port)
+	@python -mwebbrowser http://$(call sonar_ip):$(call sonar_port)
+
 load:
 	@minikube -p ${PROFILE} image load ${SERVER_IMAGE_NAME}:${VERSION}
 
@@ -122,6 +138,7 @@ dependencies-helm:
 	@helm repo add fluent https://fluent.github.io/helm-charts
 	@helm repo add grafana https://grafana.github.io/helm-charts
 	@helm repo add prometheus https://prometheus-community.github.io/helm-charts
+	@helm repo add sonarqube https://SonarSource.github.io/helm-chart-sonarqube
 	@cd charts/librarygames; \
 	helm dependencies update; \
 	helm dependencies build; \

observability/sonarqube_values.yaml

@@ -0,0 +1,12 @@
+---
+# Default values for sonarqube deployed on minikube.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+account:
+  currentAdminPassword: admin
+  adminPassword: hi
+persistence:
+  enabled: true
+service:
+  type: NodePort

server.Dockerfile

@@ -1,8 +1,6 @@
 # Dependency image
 FROM --platform=linux/amd64 golang:1.20.3 AS go-build
 
-ARG VERSION
-
 WORKDIR /tmp/librarygames/server
 
 COPY server/go.mod server/go.sum /tmp/librarygames/server
@@ -11,13 +9,41 @@ RUN go mod download
 
 COPY server/ /tmp/librarygames/server
 
+ARG VERSION
 ENV VERSION=${VERSION}
 RUN go build -mod=readonly -ldflags "-X main.version=$VERSION" -race -o /tmp/librarygames-server ./main
 
 # Test image
 FROM go-build AS go-test
 
-CMD ["go", "test", "-v", "./..."]
+RUN apt-get update && \
+  apt-get install -y \
+    unzip \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+ENV SONAR_SCANNER_VERSION=4.8.0.2856
+RUN mkdir -p /tmp/sonar \
+  && curl -sSLo /tmp/sonar/scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-$SONAR_SCANNER_VERSION-linux.zip \
+  && unzip -o /tmp/sonar/scanner.zip -d /usr/local/ \
+  && rm -rf /tmp/sonar
+RUN for exe in /usr/local/sonar-scanner-${SONAR_SCANNER_VERSION}-linux/bin/*; do ln -s ${exe} /usr/local/bin/$(basename "${exe}"); done
+
+COPY sonar-project.properties /tmp/librarygames/sonar-project.properties
+
+RUN go test -short -race -coverprofile=/tmp/cov.out `go list ./... | grep -v vendor/`
+RUN go tool cover -func=/tmp/cov.out
+RUN sed -i 's/github.com\/patrickkenney9801\/librarygames/\/tmp\/librarygames\/server/g' /tmp/cov.out
+
+ARG VERSION
+ARG SONAR_ADDRESS
+ENV SONAR_ADDRESS=${SONAR_ADDRESS}
+ENV VERSION=${VERSION}
+
+WORKDIR /tmp/librarygames
+
+RUN echo "sonar-scanner -Dsonar.host.url=$SONAR_ADDRESS -Dsonar.projectVersion=$VERSION -Dsonar.go.coverage.reportPaths=/tmp/cov.out" > sonar.sh
+
+CMD ["bash", "sonar.sh"]
 
 # Main image
 FROM --platform=linux/amd64 gcr.io/distroless/base-debian11 AS go-release

sonar-project.properties

@@ -0,0 +1,12 @@
+sonar.projectName=librarygames
+sonar.projectKey=service_sonar
+
+sonar.login=admin
+sonar.password=hi
+
+sonar.sources=server
+sonar.exclusions=**/*_test.go,**/vendor/**,**/testdata/*,**/pbs/**
+
+sonar.tests=server
+sonar.test.inclusions=**/*_test.go
+sonar.test.exclusions=**/vendor/**

src/main/java/com/nfehs/librarygames/net/GameClient.java

@@ -79,7 +79,6 @@ public void run() {
                 if (t == null) {
                   return;
                 }
-                System.out.println("Res: " + t);
 
                 // verify that user is still on the login screen, if not exit
                 if (Game.gameState != Game.LOGIN) return;
@@ -105,6 +104,9 @@ public String loginSync(final String username, final String password) {
       resp = loginStub.login(req);
     } catch (StatusRuntimeException e) {
       System.out.println("login RPC failed: " + e.getStatus());
+      if (Game.gameState == Game.LOGIN) {
+        Game.setErrorLoginScreen(e.getStatus().getDescription());
+      }
       return null;
     }
     return resp.getUserToken();
@@ -125,6 +127,9 @@ public void run() {
                   resp = createAccountStub.createAccount(req);
                 } catch (StatusRuntimeException e) {
                   System.out.println("create account RPC failed: " + e.getStatus());
+                  if (Game.gameState == Game.CREATE_ACCOUNT) {
+                    Game.setErrorCreateAccountScreen(e.getStatus().getDescription());
+                  }
                   return;
                 }