Merge pull request #108 from truthencode/feature/antlr

Feature/antlr Need to clean up archived projects and false counts on markdowns.
adarro · Sep 21, 2023 · 2c7819c · 2c7819c
2 parents d9fa6de + cf6c1ed
commit 2c7819c
Show file tree

Hide file tree

Showing 35 changed files with 276 additions and 1,684 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -37,9 +37,6 @@ jobs:
             - run: ./gradlew assemble
             - run: if [ -e ./gradlew ]; then ./gradlew reportScoverage aggregateScoverage --continue;else gradle reportScoverage aggregateScoverage --continue;fi
             - codecov/upload
-            - coverage-reporter/send_report:
-                  coverage-reports: build/reports/scoverage/cobertura.xml
-                  project-token: $CODACY_PROJECT_TOKEN
             # Download and cache dependencies
             - restore_cache:
                   keys:

diff --git a/.github/workflows/codacy_analysis.yml b/.github/workflows/codacy_analysis.yml
@@ -0,0 +1,42 @@
+name: Codacy Analysis CLI
+permissions: read-all
+"on":
+    push:
+        branches:
+            - master
+            - main
+    pull_request:
+        branches:
+            - master
+            - main
+jobs:
+    codacy-security-scan:
+        name: Codacy Security Scan
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@main
+            - name: Run Codacy Analysis CLI
+              uses: codacy/codacy-analysis-cli-action@master
+              with:
+                  output: results.sarif
+                  format: sarif
+                  gh-code-scanning-compat: true
+                  max-allowed-issues: 2147483647
+            - name: Upload SARIF results file
+              uses: github/codeql-action/upload-sarif@main
+              with:
+                  sarif_file: results.sarif
+    codacy-analysis-cli:
+        name: Codacy Analysis CLI
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@main
+            - name: Run Codacy Analysis CLI
+              uses: codacy/codacy-analysis-cli-action@master
+              with:
+                  tool: spotbugs
+                  api-token: "${{secrets.CODACY_API_TOKEN}}"
+                  upload: true
+                  max-allowed-issues: 2147483647
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -1,5 +1,5 @@
 name: Run Gradle on PRs
-
+permissions: read-all
 on: 
   push:
     branches: [master]

diff --git a/.github/workflows/sonar_analysis.yml b/.github/workflows/sonar_analysis.yml
@@ -0,0 +1,38 @@
+name: SonarCloud
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        types: [opened, synchronize, reopened]
+permissions: read-all
+jobs:
+    build:
+        name: Build and analyze
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+            - name: Set up JDK 17
+              uses: actions/setup-java@v3
+              with:
+                  java-version: 17
+                  distribution: zulu # Alternative distribution options are available
+            - name: Cache SonarCloud packages
+              uses: actions/cache@v3
+              with:
+                  path: ~/.sonar/cache
+                  key: ${{ runner.os }}-sonar
+                  restore-keys: ${{ runner.os }}-sonar
+            - name: Cache Gradle packages
+              uses: actions/cache@v3
+              with:
+                  path: ~/.gradle/caches
+                  key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle.kts') }}
+                  restore-keys: ${{ runner.os }}-gradle
+            - name: Build and analyze
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+                  SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+              run: ./gradlew build sonar --info
diff --git a/.swm/adjustable-values-and-effects.vlrn49ld.sw.md b/.swm/adjustable-values-and-effects.vlrn49ld.sw.md
@@ -0,0 +1,24 @@
+---
+id: vlrn49ld
+title: Adjustable values and Effects
+file_version: 1.1.3
+app_version: 1.17.0
+---
+
+<!--MERMAID {width:100}-->
+
+```mermaid
+\---
+title: Effect example
+\---
+erDiagram
+EFFECT ||--o{ ADJUSTMENT : places
+ORDER ||--|{ LINE-ITEM : contains
+CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
+```
+
+<!--MCONTENT {content: "\\---<br/>\ntitle: Effect example<br/>\n\\---<br/>\nerDiagram<br/>\nEFFECT ||--o{ ADJUSTMENT : places<br/>\nORDER ||--|{ LINE-ITEM : contains<br/>\nCUSTOMER }|..|{ DELIVERY-ADDRESS : uses"} --->
+
+<br/>
+
+This file was generated by Swimm. [Click here to view it in the app](https://app.swimm.io/repos/Z2l0aHViJTNBJTNBZGRvLWNhbGMlM0ElM0F0cnV0aGVuY29kZQ==/docs/vlrn49ld).
diff --git a/.swm/swimm.json b/.swm/swimm.json
@@ -0,0 +1,6 @@
+{
+    "repo_id": "Z2l0aHViJTNBJTNBZGRvLWNhbGMlM0ElM0F0cnV0aGVuY29kZQ==",
+    "configuration": {
+        "swmd": true
+    }
+}
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -29,6 +29,10 @@ lint:
         - shellcheck@0.9.0
         - shfmt@3.6.0
         - yamllint@1.32.0
+    ignore:
+        - linters: [ALL]
+          paths:
+              - incubating/**
 runtimes:
     enabled:
         - go@1.21.0

diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts
@@ -37,6 +37,8 @@ val defaultJavaToolChainVersion: String? by project
 val kasechangeVersion: String by project
 
 dependencies {
+
+    implementation("org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:4.3.1.3277")
     // enable gradle catalog for included convention plugins
     implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
     // tool languages

diff --git a/build-logic/src/main/kotlin/code-quality.gradle.kts b/build-logic/src/main/kotlin/code-quality.gradle.kts
@@ -23,6 +23,7 @@ plugins {
 
 //    id("com.github.hierynomus.license")
     id("com.diffplug.spotless")
+    id("org.sonarqube")
 //    id("com.javiersc.gradle.plugins.dependency.updates")
 }
 
@@ -140,4 +141,12 @@ configure<com.diffplug.gradle.spotless.SpotlessExtension> {
             licenseHeaderFile(project.rootProject.file("gradle/LICENSE_HEADER_SPOTLESS"), "package")
         }
     }
+}
+
+sonar {
+    properties {
+        property("sonar.projectKey", "truthencode_ddo-calc")
+        property("sonar.organization", "truthencode")
+        property("sonar.host.url", "https://sonarcloud.io")
+    }
 }
diff --git a/build-logic/src/main/kotlin/djaxonomy.test-conventions.gradle.kts b/build-logic/src/main/kotlin/djaxonomy.test-conventions.gradle.kts
@@ -111,10 +111,14 @@ fun JvmTestSuite.applyScalaTest() {
 
 project.testing {
     suites {
-        val integrationTest by registering(JvmTestSuite::class)
+        /*
+        TODO: Add functional / integration etc as needed
+        Also need to determine if this is a limited scope (i.e opt in by project)
+        integrationTest by registering(JvmTestSuite::class)
+        functionalTest by registering(JvmTestSuite::class)
+        performanceTest by registering(JvmTestSuite::class)
+         */
 
-        val functionalTest by registering(JvmTestSuite::class)
-        val performanceTest by registering(JvmTestSuite::class)
         val test by getting(JvmTestSuite::class)
         val acceptanceTest = register<JvmTestSuite>("acceptanceTest")
         configureEach {

diff --git a/docs/developers_guide/EffectZen.mmd b/docs/developers_guide/EffectZen.mmd
@@ -1,8 +1,8 @@
 zenuml
     title Effect Value Routing and Adjustment
-    @Actor Alice
+    @Actor Effect
     @Database Bob
-    @Database Mongo
+    @PUBSUB  NewItems
     Alice->Bob: Hi Bob
     Bob->Alice: Hi Alice
     Mongo->Bob: Auditing
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Welcome
+# Hi Welcome
 
 ## DDO Calculations, Planner and Plotting
 
@@ -20,6 +20,14 @@ This API will should feature Semantic Versioning once considered stable enough t
 
 [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg?style=plastic)](https://raw.githubusercontent.com/adarro/ddo-calc/master/LICENSE) [![Project Stats](https://www.openhub.net/p/ddo-calc/widgets/project_thin_badge?format=gif&ref=Thin+badge)](https://www.openhub.net/p/ddo-calc) [![GitHub forks](https://img.shields.io/github/forks/adarro/ddo-calc.svg?style=plastic)](https://github.com/adarro/ddo-calc/network) [![GitHub stars](https://img.shields.io/github/stars/adarro/ddo-calc.svg?style=plastic)](https://github.com/adarro/ddo-calc/stargazers) [![GitHub issues](https://img.shields.io/github/issues/adarro/ddo-calc.svg?style=plastic)](https://github.com/adarro/ddo-calc/issues)
 
-[![Build status](https://ci.appveyor.com/api/projects/status/pnp0ghiwcu2lpkft?svg=true)](https://ci.appveyor.com/project/adarro/ddo-calc) [![Dependency Status](https://www.versioneye.com/user/projects/58c90554d01cb20045124875/badge.svg?style=plastic)](https://www.versioneye.com/user/projects/58c90554d01cb20045124875) [![CircleCI](https://circleci.com/gh/truthencode/ddo-calc/tree/master.svg?style=shield)](https://circleci.com/gh/truthencode/ddo-calc/?branch=master)
+[![Build status](https://ci.appveyor.com/api/projects/status/pnp0ghiwcu2lpkft?svg=true)](https://ci.appveyor.com/project/adarro/ddo-calc) [![Dependency Status](https://www.versioneye.com/user/projects/58c90554d01cb20045124875/badge.svg?style=plastic)](https://www.versioneye.com/user/projects/58c90554d01cb20045124875) [![CircleCI](https://circleci.com/gh/truthencode/ddo-calc/tree/master.svg?style=shield)](https://circleci.com/gh/truthencode/ddo-calc/?branch=master) [![Documentation Status](https://readthedocs.org/projects/ddo-calc/badge/?version=latest)](https://ddo-calc.readthedocs.io/en/latest/?badge=latest)
 
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a32019b5ef2f4fe6a58a348a61184c3a)](https://app.codacy.com/gh/truthencode/ddo-calc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=truthencode_ddo-calc)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc) [![Codecov](https://img.shields.io/codecov/c/github/adarro/ddo-calc.svg?maxAge=2592000?style=plastic)](https://codecov.io/github/adarro/ddo-calc)
+[![Coverage Graph](https://codecov.io/gh/truthencode/ddo-calc/graphs/tree.svg?token=nGgcixP5rr)]
+
+| [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=truthencode_ddo-calc)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc)                            | [![Codacy Badge](https://app.codacy.com/project/badge/Grade/a32019b5ef2f4fe6a58a348a61184c3a)](https://app.codacy.com/gh/truthencode/ddo-calc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) <br>[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/a32019b5ef2f4fe6a58a348a61184c3a)](https://app.codacy.com/gh/truthencode/ddo-calc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)<br>[![codecov](https://codecov.io/gh/truthencode/ddo-calc/graph/badge.svg?token=nGgcixP5rr)](https://codecov.io/gh/truthencode/ddo-calc) |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=truthencode_ddo-calc&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc)       |
+| [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=truthencode_ddo-calc&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc)   |
+| [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=truthencode_ddo-calc&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc)       |
+| [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=truthencode_ddo-calc&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc) |
+| [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=truthencode_ddo-calc&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=truthencode_ddo-calc)                   |
diff --git a/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.jvm b/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.jvm
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode
 #

diff --git a/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.legacy-jar b/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.legacy-jar
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode
 #

diff --git a/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.native b/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.native
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
 #

diff --git a/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.native-micro b/incubating/amqp-quickstart-producer/src/main/docker/Dockerfile.native-micro
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
 # It uses a micro base image, tuned for Quarkus native executables.

diff --git a/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.jvm b/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.jvm
@@ -1,5 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
 # trunk-ignore-all(checkov/CKV_DOCKER_2)
-
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode
 #

diff --git a/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.legacy-jar b/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.legacy-jar
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode
 #

diff --git a/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.native b/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.native
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
 #

diff --git a/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.native-micro b/incubating/poc-scala-quarkus/src/main/docker/Dockerfile.native-micro
@@ -1,3 +1,5 @@
+# trunk-ignore-all(trivy/DS026)
+# trunk-ignore-all(checkov/CKV_DOCKER_2)
 ####
 # This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode.
 # It uses a micro base image, tuned for Quarkus native executables.

diff --git a/incubating/poc-scala-quarkus/src/main/resources/META-INF/resources/index.html b/incubating/poc-scala-quarkus/src/main/resources/META-INF/resources/index.html
@@ -363,6 +363,7 @@ <h1>You just made a Quarkus application.</h1>
                 href="https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources"
                 class="guide-link"
                 target="_blank"
+                rel="noopener"
                 >Related guide</a
               >
             </li>