vintner info

OpenTOSCA · Jul 19, 2023 · bd42cfa · bd42cfa
1 parent c2e2741
commit bd42cfa
Show file tree

Hide file tree

Showing 35 changed files with 287 additions and 42 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -36,6 +36,9 @@ jobs:
             #
             ###################################################
 
+            - name: (DOCS) Generate Dependencies Page
+              run: yarn docs:generate:dependencies
+
             - name: (BUILD) Build Project
               run: yarn build
 

diff --git a/.github/workflows/night.yaml b/.github/workflows/night.yaml
@@ -105,11 +105,35 @@ jobs:
                   wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-linux-x64.asc
                   gpg --verify vintner-linux-x64.asc /usr/bin/vintner
 
-            - name: (INSTALLATION) Test setup
+            ###################################################
+            #
+            # Vintner
+            #
+            ###################################################
+
+            - name: (VINTNER) Ensure that version is overridden
               run: |
-                  vintner --version
-                  vintner setup init
-                  vintner setup benchmark --seeds 10 250
+                  if [ "$(vintner --version)" == "__VERSION__" ]; then 
+                    exit 1
+                  fi
+
+            - name: (VINTNER) Ensure that license is overridden
+              run: |
+                  if [ "$(vintner info license)" == "$(cat src/assets/LICENSE)" ]; then
+                    exit 1
+                  fi
+
+            - name: (VINTNER) Ensure that dependencies are overridden
+              run: |
+                  if [ "$(vintner info dependencies)" == "$(cat src/assets/dependencies.csv)" ]; then 
+                    exit 1
+                  fi
+
+            - name: (VINTNER) Test filesystem initialization
+              run: vintner setup init
+
+            - name: (VINTNER) Test resolver
+              run: vintner setup benchmark --seeds 10 250
 
             ###################################################
             #

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -61,8 +61,8 @@ jobs:
             - name: (TEST) Check Prettier
               run: yarn style:check
 
-            - name: (TEST) Check Licenses
-              run: yarn licenses:check
+            - name: (TEST) Check Dependencies
+              run: yarn dependencies:check
 
             - name: (TEST) Check Service Templates
               run: yarn puccini:check
@@ -82,6 +82,9 @@ jobs:
             #
             ###################################################
 
+            - name: (DOCS) Generate Dependencies Page
+              run: yarn docs:generate:dependencies
+
             - name: (BUILD) Build Project
               run: yarn build
 
@@ -176,9 +179,6 @@ jobs:
             - name: (DOCS) Build Documentation Commands
               run: yarn docs:build:commands
 
-            - name: (DOCS) Generate Licenses Page
-              run: yarn docs:generate:licenses
-
             - name: (DOCS) Generate Interface Page
               run: yarn docs:generate:interface
 

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -54,8 +54,8 @@ jobs:
             - name: (TEST) Check Prettier
               run: yarn style:check
 
-            - name: (TEST) Check Licenses
-              run: yarn licenses:check
+            - name: (TEST) Check Dependencies
+              run: yarn dependencies:check
 
             - name: (TEST) Check Service Templates
               run: yarn puccini:check
@@ -69,6 +69,9 @@ jobs:
             #
             ###################################################
 
+            - name: (DOCS) Generate Dependencies Page
+              run: yarn docs:generate:dependencies
+
             - name: (BUILD) Build Project
               run: yarn build
 
@@ -96,9 +99,6 @@ jobs:
             - name: (DOCS) Build Documentation Commands
               run: yarn docs:build:commands
 
-            - name: (DOCS) Generate Licenses Page
-              run: yarn docs:generate:licenses
-
             - name: (DOCS) Generate Interface Page
               run: yarn docs:generate:interface
 

diff --git a/Dockerfile b/Dockerfile
@@ -8,7 +8,7 @@ RUN yarn --frozen-lockfile
 # Test
 RUN yarn lint:check
 RUN yarn style:check
-RUN yarn licenses:check
+RUN yarn dependencies:check
 RUN yarn puccini:check
 RUN yarn test
 
@@ -24,7 +24,7 @@ RUN apt-get update -y \
     && rm -rf /var/lib/apt/lists/*
 RUN yarn docs:install
 RUN yarn docs:build:commands
-RUN yarn docs:generate:licenses
+RUN yarn docs:generate:dependencies
 RUN yarn docs:generate:interface
 RUN yarn docs:generate:tests:variability
 RUN yarn docs:generate:tests:query

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 [![MiniSat](https://img.shields.io/badge/MiniSat-%E2%9D%A4%EF%B8%8F-ff69b4)](https://github.com/meteor/logic-solver)
 
 OpenTOSCA Vintner is a TOSCA preprocessing and management layer which is able to deploy applications based on TOSCA orchestrator plugins.
-Preprocessing includes, e.g., the resolving of variability.
+Preprocessing includes, e.g., the resolving of deployment variability.
 
 - [Documentation](https://vintner.opentosca.org)
 - [Getting Started](https://vintner.opentosca.org/getting-started)

diff --git a/docs/cmds/licenses/generate.ts → docs/cmds/dependencies/generate.ts b/docs/cmds/licenses/generate.ts → docs/cmds/dependencies/generate.ts
@@ -7,7 +7,7 @@ import * as files from '#files'
 import * as path from 'path'
 import * as utils from './utils'
 
-const CSV_FILE = path.join('docs', 'docs', 'assets', 'documents', 'licenses.csv')
+const CSV_FILE = path.join('docs', 'docs', 'assets', 'documents', 'dependencies.csv')
 
 async function main() {
     /**

diff --git a/...cmds/licenses/license-checker-format.json → .../dependencies/license-checker-format.json b/...cmds/licenses/license-checker-format.json → .../dependencies/license-checker-format.json
diff --git a/docs/cmds/licenses/template.ejs → docs/cmds/dependencies/template.ejs b/docs/cmds/licenses/template.ejs → docs/cmds/dependencies/template.ejs
@@ -5,10 +5,10 @@ tags:
 
 # Dependencies
 
-{{ autogenerated_notice('yarn docs:generate:licenses') }}
+{{ autogenerated_notice('yarn docs:generate:dependencies') }}
 
 We use the following dependencies in production.
-You can download the dataset as [CSV](assets/documents/licenses.csv).
+You can download the dataset as [CSV](assets/documents/dependencies.csv).
 We ensure, that only the licenses <%- "MIT;Apache-2.0;Python-2.0;BSD-2-Clause;BSD-3-Clause;ISC;CC-BY-3.0;CC0-1.0;PSF;0BSD;BlueOak-1.0.0".split(";").sort().map(license => `[${license}](${licenses[license]}){target=_blank}`).join(", ") -%> are used.
 
 | ID | Dependency | Version | License |

diff --git a/docs/cmds/licenses/types.ts → docs/cmds/dependencies/types.ts b/docs/cmds/licenses/types.ts → docs/cmds/dependencies/types.ts
diff --git a/docs/cmds/licenses/utils.ts → docs/cmds/dependencies/utils.ts b/docs/cmds/licenses/utils.ts → docs/cmds/dependencies/utils.ts
diff --git a/docs/cmds/interface/generate.ts b/docs/cmds/interface/generate.ts
@@ -94,7 +94,7 @@ async function main() {
 }
 
 function isCLIOnly(commands: string[]) {
-    return ['server', 'sensors'].includes(commands[0]) || ['open', 'path', 'code'].includes(commands[1])
+    return ['server', 'sensors', 'info'].includes(commands[0]) || ['open', 'path', 'code'].includes(commands[1])
 }
 
 main()
diff --git a/docs/docs/assets/documents/licenses.csv → docs/docs/assets/documents/dependencies.csv b/docs/docs/assets/documents/licenses.csv → docs/docs/assets/documents/dependencies.csv
diff --git a/docs/docs/contributing/development.md b/docs/docs/contributing/development.md
@@ -109,14 +109,14 @@ Run the following command, to run to benchmark the variability resolving.
 yarn benchmark
 ```
 
-## Licenses
+## Dependencies
 
-[license-checker](https://github.com/davglass/license-checker){target=_blank} is used for handling licenses of (transitive) dependencies.
+We use [license-checker](https://github.com/davglass/license-checker){target=_blank} for handling licenses of (transitive) dependencies.
 To check that (transitive) dependencies are licensed as expected, run the following command.
 This check is also executed inside workflows.
 
 ```shell linenums="1"
-yarn licenses:check
+yarn dependencies:check
 ```
 
 

diff --git a/docs/docs/contributing/documentation.md b/docs/docs/contributing/documentation.md
@@ -50,13 +50,13 @@ To warn the developer, include the following custom marco at the top of the temp
 
 ```text linenums="1"
 {% raw %}
-{{ autogenerated_notice('yarn docs:generate:licenses') }}
+{{ autogenerated_notice('yarn docs:generate:dependencies') }}
 {% endraw %}
 ```
 
 This will render the following warning, if the docs are served using `yarn docs:serve` but not when built.
 
-{{ autogenerated_notice('yarn docs:generate:licenses', True) }}
+{{ autogenerated_notice('yarn docs:generate:dependencies', True) }}
 
 
 ## Casts
@@ -117,13 +117,13 @@ This command is also executed during the `release` workflow and, therefore, over
 yarn docs:generate:interface
 ```
 
-## Licenses
+## Dependencies
 
 To generate a list of licenses for all (transitive) dependencies, run the following command
 This command is also executed during the `release` workflow and, therefore, overwrites respective files.
 
 ```shell linenums="1"
-yarn docs:generate:licenses
+yarn docs:generate:dependencies
 ```
 
 The list includes information such as package name, version, license, etc. and is written to a CSV file.

diff --git a/docs/docs/dependencies.md b/docs/docs/dependencies.md
@@ -5,10 +5,10 @@ tags:
 
 # Dependencies
 
-{{ autogenerated_notice('yarn docs:generate:licenses') }}
+{{ autogenerated_notice('yarn docs:generate:dependencies') }}
 
 We use the following dependencies in production.
-You can download the dataset as [CSV](assets/documents/licenses.csv).
+You can download the dataset as [CSV](assets/documents/dependencies.csv).
 We ensure, that only the licenses [0BSD](https://choosealicense.com/licenses/0bsd){target=_blank}, [Apache-2.0](https://choosealicense.com/licenses/apache-2.0){target=_blank}, [BSD-2-Clause](https://choosealicense.com/licenses/bsd-2-clause){target=_blank}, [BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause){target=_blank}, [BlueOak-1.0.0](https://blueoakcouncil.org/license/1.0.0){target=_blank}, [CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/){target=_blank}, [CC0-1.0](https://choosealicense.com/licenses/cc0-1.0){target=_blank}, [ISC](https://choosealicense.com/licenses/isc){target=_blank}, [MIT](https://choosealicense.com/licenses/mit){target=_blank}, [PSF](http://docs.python.org/license.html){target=_blank}, [Python-2.0](https://opensource.org/licenses/Python-2.0){target=_blank} are used.
 
 | ID | Dependency | Version | License |

diff --git a/docs/docs/interface.md b/docs/docs/interface.md
@@ -7,6 +7,72 @@ tags:
 
 {{ autogenerated_notice('yarn docs:generate:interface') }}
 
+## vintner info about
+
+general information
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info about 
+    ```
+
+
+## vintner info contact
+
+contact us
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info contact 
+    ```
+
+
+## vintner info dependencies
+
+dependencies used to implement vintner
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info dependencies 
+    ```
+
+
+## vintner info docs
+
+open documentation
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info docs 
+    ```
+
+
+## vintner info license
+
+license of vintner
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info license 
+    ```
+
+
+## vintner info repo
+
+open repository
+
+
+=== "CLI"
+    ```shell linenums="1"
+    vintner info repo 
+    ```
+
+
 ## vintner instances adapt
 
 submit sensor data used for adapting the instance

diff --git a/package.json b/package.json
@@ -93,7 +93,7 @@
         "git:fix": "git add . && git commit -m fix && git push",
         "git:improve-docs": "git add . && git commit -m \"improve docs\" && git push",
         "git:open": "open-cli https://github.com/opentosca/opentosca-vintner",
-        "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && syncdir src/assets build/assets --quiet",
+        "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && syncdir src/assets build/assets --quiet && cp LICENSE build/assets && cp docs/docs/assets/documents/dependencies.csv build/assets",
         "package": "pkg --config .pkgrc.json build/cli/index.js",
         "deploy": "sudo cp ./dist/vintner-linux-x64 /usr/bin/vintner",
         "lint:check": "eslint .",
@@ -118,7 +118,7 @@
         "docs:deploy": "bash docs/cmds/mkdocs gh-deploy --force --strict",
         "docs:build:commands": "tsc -p tsconfig.docs.json && tsc-alias -p tsconfig.docs.json && syncdir docs/cmds build-docs/docs/cmds --quiet && syncdir src/assets build-docs/src/assets --quiet && syncdir tests build-docs/tests --quiet",
         "docs:generate:interface": "bash docs/cmds/command.sh interface",
-        "docs:generate:licenses": "bash docs/cmds/command.sh licenses",
+        "docs:generate:dependencies": "bash docs/cmds/command.sh dependencies",
         "docs:generate:tests:variability": "bash docs/cmds/command.sh variability",
         "docs:generate:tests:query": "bash docs/cmds/command.sh query",
         "docs:generate:sofdcar": "bash docs/cmds/command.sh sofdcar",
@@ -131,7 +131,7 @@
         "docs:export:local": "bash docs/cmds/export/generate.sh http://localhost:8000",
         "examples:xopera": "bash examples/xopera-motivation/demo.sh",
         "examples:unfurl": "bash examples/unfurl-motivation/demo.sh",
-        "licenses:check": "license-checker --production --summary --onlyAllow \"MIT;Apache-2.0;Python-2.0;BSD-2-Clause;BSD-3-Clause;ISC;CC-BY-3.0;CC0-1.0;PSF;0BSD;BlueOak-1.0.0\" --excludePackages [email protected]",
+        "dependencies:check": "license-checker --production --summary --onlyAllow \"MIT;Apache-2.0;Python-2.0;BSD-2-Clause;BSD-3-Clause;ISC;CC-BY-3.0;CC0-1.0;PSF;0BSD;BlueOak-1.0.0\" --excludePackages [email protected]",
         "puccini:check": "bash docs/cmds/puccini/check-all.sh",
         "puccini:check:single": "bash docs/cmds/puccini/check.sh",
         "puml:up": "cd docs && docker-compose up -d",

diff --git a/src/assets/LICENSE b/src/assets/LICENSE
@@ -0,0 +1 @@
+Do not edit this file. This file is overridden during builds.
diff --git a/src/assets/dependencies.csv b/src/assets/dependencies.csv
@@ -0,0 +1 @@
+Do not edit this file. This file is overridden during builds.