Merge pull request #15 from lstreckeisen/CMI-79-Create-SemanticTokenProvider-for-language-server

Cmi 79 create semantic token provider for language server

Author: lstreckeisen

.github/workflows/build.yml

@@ -16,12 +16,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     container:
-      image: node:22-alpine
+      image: node:22-slim
     steps:
+      - name: Prepare debian
+        run: |
+          apt update
+          apt install -y git wget unzip
       # required since test report action uses git
       - name: Setup git
         run: |
-          apk --no-cache add git
           REPO_NAME=$(echo "${GITHUB_REPOSITORY}" | cut -d'/' -f2)
           git config --global --add safe.directory "/__w/$REPO_NAME/$REPO_NAME"
 
@@ -48,6 +51,11 @@ jobs:
           path: out/test-results.xml
           reporter: java-junit
 
+      - name: SonarQube Scan
+        uses: SonarSource/sonarqube-scan-action@v5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
       - name: Build
         run: yarn build
 

.github/workflows/sonar.yml

@@ -5,6 +5,7 @@
 node_modules/
 out/
 dist/
+coverage/
 src/language/generated/
 syntaxes/
 .idea

.gitignore

@@ -28,7 +28,7 @@
         "langium:generate:production": "langium generate --mode=production",
         "langium:watch": "langium generate --watch",
         "bundle:language-server": "npx ncc build dist/main.cjs -o cml-ls",
-        "test": "vitest run",
+        "test": "vitest run --coverage",
         "clean": "rm -rf src/language/generated && rm -rf cml-ls/ && rm -rf dist/"
     },
     "dependencies": {
@@ -41,6 +41,7 @@
         "@typescript-eslint/eslint-plugin": "~7.3.1",
         "@typescript-eslint/parser": "~7.3.1",
         "@vercel/ncc": "^0.38.3",
+        "@vitest/coverage-v8": "^3.1.1",
         "concurrently": "~8.2.1",
         "esbuild": "~0.20.2",
         "eslint": "~8.57.0",
@@ -50,7 +51,7 @@
         "eslint-plugin-promise": "^7.2.1",
         "langium-cli": "~3.4.0",
         "typescript": "~5.1.6",
-        "vitest": "~1.4.0"
+        "vitest": "^3.1.1"
     },
     "packageManager": "yarn@4.8.1"
 }

.yarn/install-state.gz

@@ -3,12 +3,13 @@ sonar.organization=lstreckeisen
 
 
 # This is the name and version displayed in the SonarCloud UI.
-#sonar.projectName=context-mapper-language-server
+sonar.projectName=context-mapper-language-server
 #sonar.projectVersion=1.0
 
 
 # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
 #sonar.sources=.
 
 # Encoding of the source code. Default is default system encoding
-#sonar.sourceEncoding=UTF-8
+sonar.sourceEncoding=UTF-8
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info

package.json

@@ -0,0 +1,32 @@
+import { createContextMapperDslServices } from '../../src/language/ContextMapperDslModule.js'
+import { parseHelper } from 'langium/test'
+import { ContextMappingModel } from '../../src/language/generated/ast.js'
+import { EmptyFileSystem } from 'langium'
+import { beforeAll, describe, expect, test } from 'vitest'
+import fs from 'fs'
+import { parseValidInput } from './ParsingTestHelper.js'
+import path from 'node:path'
+
+let services: ReturnType<typeof createContextMapperDslServices>
+let parse: ReturnType<typeof parseHelper<ContextMappingModel>>
+
+beforeAll(async () => {
+  services = createContextMapperDslServices(EmptyFileSystem)
+  parse = parseHelper<ContextMappingModel>(services.ContextMapperDsl)
+})
+
+describe('Example file parsing tests', () => {
+  test('Parse example files', async () => {
+    const dir = path.resolve(__dirname, 'example-files')
+    fs.readdir(dir, (err, files) => {
+      expect(err).toBeNull()
+      files.forEach(file => {
+        fs.readFile(path.resolve(dir, file), { encoding: 'utf8' }, async (err, data) => {
+          console.log('test parsing of file:', file)
+          expect(err).toBeNull()
+          await parseValidInput(parse, data)
+        })
+      })
+    })
+  })
+})

sonar-project.properties

@@ -0,0 +1,53 @@
+/* The DDD Cargo sample application modeled in CML. Note that we split the application into multiple bounded contexts. */
+ContextMap DDDSampleMap {
+	contains CargoBookingContext
+	contains VoyagePlanningContext
+	contains LocationContext
+	
+	/* As Evans mentions in his book (Bounded Context chapter): The voyage planning can be seen as 
+	 * separated bounded context. However, it still shares code with the booking application (CargoBookingContext).
+	 * Thus, they are in a 'Shared-Kernel' relationship.
+	 */
+	CargoBookingContext [SK]<->[SK] VoyagePlanningContext
+	
+	/* Note that the splitting of the LocationContext is not mentioned in the original DDD sample of Evans.
+	 * However, locations and the management around them, can somehow be seen as a separated concept which is used by other
+	 * bounded contexts. But this is just an example, since we want to demonstrate our DSL with multiple bounded contexts.
+	 */
+	CargoBookingContext [D]<-[U,OHS,PL] LocationContext
+	
+	VoyagePlanningContext [D]<-[U,OHS,PL] LocationContext
+	
+}
+
+/* The original booking application context */
+BoundedContext CargoBookingContext {
+	Module cargo {
+		basePackage = se.citerus.dddsample.domain.model
+		
+		Aggregate CargoItineraryLegDeliveryRouteSpecification
+	}
+	Module handling {
+		basePackage = se.citerus.dddsample.domain.model
+		
+		Aggregate Handling
+	}
+}
+
+/* We split the Voyage Planning into a separate bounded context as Evans proposes it in his book. */
+BoundedContext VoyagePlanningContext {
+	Module voyage {
+		basePackage = se.citerus.dddsample.domain.model
+		
+		Aggregate Voyage
+	}
+}
+
+/* Separate bounded context for managing the locations. */
+BoundedContext LocationContext {
+	Module location {
+		basePackage = se.citerus.dddsample.domain.model
+		
+		Aggregate Location
+	}
+}

test/parsing/ExampleFileParsing.test.ts

@@ -6,12 +6,12 @@ import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
     test: {
-        // coverage: {
-        //     provider: 'v8',
-        //     reporter: ['text', 'html'],
-        //     include: ['src'],
-        //     exclude: ['**/generated'],
-        // },
+        coverage: {
+            provider: 'v8',
+            reporter: ['lcov'],
+            include: ['src'],
+            exclude: ['**/generated']
+        },
         deps: {
             interopDefault: true
         },