Makes minor improvements to PR-294

.markdownlint.yaml

@@ -0,0 +1,7 @@
+default: true
+MD033: false
+MD013: 
+  code_blocks: false
+  tables: false
+MD046: 
+  style: "fenced"

.pre-commit-config.yaml

@@ -0,0 +1,88 @@
+default_install_hook_types: [pre-commit, pre-push]
+
+repos:
+  - repo: local
+    hooks:
+      - id: yarn-install-client
+        name: yarn install client
+        entry: bash
+        language: system
+        files: "^client/.*"
+        args: ["-c", "cd client && yarn install"]
+      - id: yarn-install-runner
+        name: yarn install runner
+        entry: bash
+        language: system
+        files: "^servers/execution/runner/.*"
+        args: ["-c", "cd servers/execution/runner && yarn install"]
+      - id: yarn-install-lib
+        name: yarn install lib
+        entry: bash
+        language: system
+        files: "^servers/lib/.*"
+        args: ["-c", "cd servers/lib && yarn install"]
+
+      - id: yarn-jest-client
+        name: yarn jest client
+        entry: bash
+        language: system
+        files: "^client/.*"
+        args: ["-c", "cd client && yarn jest . --coverage=false"]
+        stages: [pre-push]
+      - id: yarn-test-runner
+        name: yarn test runner
+        entry: bash
+        language: system
+        files: "^servers/execution/runner/.*"
+        args: ["-c", "cd servers/execution/runner && yarn test:nocov"]
+        stages: [pre-push]
+      # - id: yarn-test-lib
+      #   name: yarn test lib
+      #   entry: bash
+      #   language: system
+      #   files: "^servers/lib/.*"
+      #   args: ["-c", "cd servers/lib && yarn jest . --coverage=false"]
+      #   stages: [pre-push]
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        args: ["--ignore-path", "../.gitignore", "--write"]
+        files: '^(client|servers/execution/runner|servers/lib)/.*\.(ts|tsx|css|scss)$'
+        stages: [pre-commit]
+
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v8.54.0
+    hooks:
+      - id: eslint
+        args: ["--fix"]
+        files: "^(client|servers/execution/runner|servers/lib)/.*"
+        stages: [pre-commit]
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.37.0
+    hooks:
+      - id: markdownlint
+        files: '.*\.md$'
+        entry: ./script/markdownlint-hook.sh
+        verbose: true
+        stages: [pre-commit]
+
+  - repo: https://github.com/syntaqx/git-hooks
+    rev: v0.0.18
+    hooks:
+      - id: shellcheck
+        files: '.*'
+        stages: [pre-commit]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-json
+        files: '^(docs|deploy|script|ssl)/.*'
+        stages: [pre-commit]
+      - id: check-yaml
+        files: '^(docs|deploy|script|ssl)/.*'
+        stages: [pre-commit]
+

LICENSE.md

@@ -20,10 +20,10 @@
 
 * The INTO-CPS tool suite software and the INTO-CPS Association
 * Public License (ICAPL) are obtained from the INTO-CPS Association, either
-* from the above address, from the URLs: <http:>http://www.into-cps.org</http:> or
+* from the above address, from the URLs: <http://www.into-cps.org> or
 * in the INTO-CPS tool suite distribution.
 * GNU version 3 is obtained from:
-* <http:>http://www.gnu.org/copyleft/gpl.html</http:>.
+* <http://www.gnu.org/copyleft/gpl.html>.
 
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of  MERCHANTABILITY or FITNESS
@@ -291,11 +291,11 @@ This Agreement is governed by the laws of Denmark. The place of jurisdiction
 for all disagreements related to this Agreement, is Aarhus, Denmark.
 
 The EPL 1.0 license definition has been obtained from:
-<http:>http://www.eclipse.org/legal/epl-v10.html</http:>.
+<http://www.eclipse.org/legal/epl-v10.html>.
 It is also reproduced in the INTO-CPS distribution.
 
 The GPL Version 3 license definition has been obtained from
-<http:>http://www.gnu.org/copyleft/gpl.html</http:>.
+<http://www.gnu.org/copyleft/gpl.html>.
 It is also reproduced in the INTO-CPS distribution.
 
 --- End of Definition of INTO-CPS Association Public License ---

README.md

@@ -23,6 +23,19 @@ to install and use the DTaaS software platform.
 You are welcome to open an [issue](https://github.com/INTO-CPS-Association/DTaaS/issues/new/choose)
 if there is a suggestion to improve the software.
 
+If you find this repo useful for your research, please consider citing our paper:
+
+```bibtex
+@misc{talasila2023digital,
+      title={Digital Twin as a Service (DTaaS): A Platform for Digital Twin Developers and Users}, 
+      author={Prasad Talasila and Cláudio Gomes and Peter Høgh Mikkelsen and Santiago Gil Arboleda and Eduard Kamburjan and Peter Gorm Larsen},
+      year={2023},
+      eprint={2305.07244},
+      archivePrefix={arXiv},
+      primaryClass={cs.SE}
+}
+```
+
 ## :hammer_and_wrench: Development Setup
 
 This is a mono repo containing code for

client/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

client/LICENSE.md

@@ -20,10 +20,10 @@
 
 * The INTO-CPS tool suite software and the INTO-CPS Association
 * Public License (ICAPL) are obtained from the INTO-CPS Association, either
-* from the above address, from the URLs: <http:>http://www.into-cps.org</http:> or
+* from the above address, from the URLs: <http://www.into-cps.org> or
 * in the INTO-CPS tool suite distribution.
 * GNU version 3 is obtained from:
-* <http:>http://www.gnu.org/copyleft/gpl.html</http:>.
+* <http://www.gnu.org/copyleft/gpl.html>.
 
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of  MERCHANTABILITY or FITNESS
@@ -291,11 +291,11 @@ This Agreement is governed by the laws of Denmark. The place of jurisdiction
 for all disagreements related to this Agreement, is Aarhus, Denmark.
 
 The EPL 1.0 license definition has been obtained from:
-<http:>http://www.eclipse.org/legal/epl-v10.html</http:>.
+<http://www.eclipse.org/legal/epl-v10.html>.
 It is also reproduced in the INTO-CPS distribution.
 
 The GPL Version 3 license definition has been obtained from
-<http:>http://www.gnu.org/copyleft/gpl.html</http:>.
+<http://www.gnu.org/copyleft/gpl.html>.
 It is also reproduced in the INTO-CPS distribution.
 
 --- End of Definition of INTO-CPS Association Public License ---

client/public/static/css/MaterialIcon.css

@@ -4,7 +4,9 @@
   font-family: 'Material Icons';
   font-style: normal;
   font-weight: 400;
-  src: local('Material Icons'), local('MaterialIcons-Regular'),
+  src:
+    local('Material Icons'),
+    local('MaterialIcons-Regular'),
     url(/static/font/MaterialIcons-Regular.woff2) format('woff2'),
     url(/static/font/MaterialIcons-Regular.woff) format('woff'),
     url(/static/font/MaterialIcons-Regular.ttf) format('truetype');

client/src/components/tab/TabComponent.tsx

@@ -24,7 +24,7 @@ function renderScopeTabList(scope: TabData[][], subIndex: number): JSX.Element {
 
 function renderScopeTabPanels(
   scope: TabData[][],
-  subIndex: number
+  subIndex: number,
 ): JSX.Element {
   return (
     <>

client/src/index.tsx

@@ -57,7 +57,7 @@ const router = createBrowserRouter(
   ],
   {
     basename: `/${useURLbasename()}`,
-  }
+  },
 );
 
 const root = document.getElementById('root');
@@ -68,7 +68,7 @@ if (root) {
       <AppProvider>
         <RouterProvider router={router} />
       </AppProvider>
-    </React.StrictMode>
+    </React.StrictMode>,
   );
 } else {
   throw Error("Couldn't find root element");

client/src/route/library/Library.tsx

@@ -32,7 +32,7 @@ export function createCombinedTabs() {
           />
         </>
       ),
-    }))
+    })),
   );
 }
 

client/test/README.md

@@ -182,4 +182,3 @@ yarn test -e
 This command launches the test runner and executes all end-to-end tests.
 Make sure you have an active internet connection while running these tests,
 as they simulate real user interactions with your GitLab account.
-

client/test/e2e/playwright/Auth.test.ts

@@ -13,7 +13,7 @@ test.describe('Tests on Authentication Flow', () => {
       .getByRole('button', { name: 'GitLab logo Sign In with GitLab' })
       .click();
     await expect(
-      page.getByRole('button', { name: 'Open settings' })
+      page.getByRole('button', { name: 'Open settings' }),
     ).toBeVisible();
     await expect(page).toHaveURL(/.*Library/);
   });
@@ -23,7 +23,7 @@ test.describe('Tests on Authentication Flow', () => {
       .getByRole('button', { name: 'GitLab logo Sign In with GitLab' })
       .click();
     await expect(
-      page.getByRole('button', { name: 'Open settings' })
+      page.getByRole('button', { name: 'Open settings' }),
     ).toBeVisible();
     await expect(page).toHaveURL(/.*Library/);
 

client/test/e2e/playwright/Menu.test.ts

@@ -10,7 +10,7 @@ test.describe('Menu Links from first page (Layout)', () => {
       .getByRole('button', { name: 'GitLab logo Sign In with GitLab' })
       .click();
     await expect(
-      page.getByRole('button', { name: 'Open settings' })
+      page.getByRole('button', { name: 'Open settings' }),
     ).toBeVisible();
     await expect(page).toHaveURL(/.*Library/);
   });
@@ -19,7 +19,7 @@ test.describe('Menu Links from first page (Layout)', () => {
     await links.reduce(async (previousPromise, link) => {
       await previousPromise;
       const linkElement = await page.locator(
-        `div[role="button"]:has-text("${link.text}")`
+        `div[role="button"]:has-text("${link.text}")`,
       );
       await expect(linkElement).toBeVisible();
     }, Promise.resolve());

client/test/e2e/playwright/auth.setup.ts

@@ -42,7 +42,7 @@ setup('authenticate', async ({ page }) => {
     // 'Authorize' button did not appear within 4 seconds, so just ignore and continue.
   }
   await expect(
-    page.getByRole('button', { name: 'Open settings' })
+    page.getByRole('button', { name: 'Open settings' }),
   ).toBeVisible();
 
   const storage = await page.context().storageState();

client/test/integration/authRedux.test.tsx

@@ -49,7 +49,7 @@ const setupTest = (authState: AuthState) => {
     <PrivateRoute>
       <Library />
     </PrivateRoute>,
-    { route: '/private', store }
+    { route: '/private', store },
   );
 };
 
@@ -75,7 +75,7 @@ describe('Redux and Authentication integration test', () => {
 
     expect(screen.getByText('Signin')).toBeInTheDocument();
     expect(authReducer(undefined, { type: 'unknown' })).toEqual(
-      initialState.auth
+      initialState.auth,
     );
     expect(store.getState().userName).toBe(undefined);
   });

client/test/unitTests/Components/Linkbuttons.test.tsx

@@ -24,7 +24,7 @@ const getButtonIcon = (key: string) =>
 const evaluateButtonSize = (expectedSize: number) => {
   buttons.forEach((button) => {
     expect(
-      getComputedStyle(getButtonIcon(button.key)).getPropertyValue('font-size')
+      getComputedStyle(getButtonIcon(button.key)).getPropertyValue('font-size'),
     ).toBe(`${expectedSize}rem`);
   });
 };
@@ -38,7 +38,7 @@ describe('LinkButtons component default size', () => {
     buttons.forEach((button) => {
       expect(getButton(button.key).parentElement).toHaveAttribute(
         'aria-label',
-        button.link
+        button.link,
       );
       expect(getLabel(button.key).tagName).toBe('H6');
     });
@@ -66,7 +66,7 @@ describe('LinkButtons component default size', () => {
 
   it('should use name from iconLib as label when avaiable', () => {
     expect(getLabel(buttons[0].key).textContent).toBe(
-      LinkIcons[buttons[0].key].name
+      LinkIcons[buttons[0].key].name,
     );
   });
 });

client/test/unitTests/Components/PrivateRoute.test.tsx

@@ -30,7 +30,7 @@ const setupTest = (authState: AuthState) => {
     <PrivateRoute>
       <TestComponent />
     </PrivateRoute>,
-    { route: '/private' }
+    { route: '/private' },
   );
 };