chore: rename EXHORT_ opts to TRUSTIFY_DA_

Author: Strum355

.github/workflows/pr.yml

@@ -91,8 +91,8 @@ jobs:
 
       - name: Run unit tests
         env:
-          EXHORT_PYTHON3_PATH: "${{steps.python-location.outputs.python-bin-location}}/python3"
-          EXHORT_PIP3_PATH: "${{steps.python-location.outputs.python-bin-location}}/pip3"
+          TRUSTIFY_DA_PYTHON3_PATH: "${{steps.python-location.outputs.python-bin-location}}/python3"
+          TRUSTIFY_DA_PIP3_PATH: "${{steps.python-location.outputs.python-bin-location}}/pip3"
         run: npm run test
 
       - name: Compile project
@@ -105,7 +105,7 @@ jobs:
         working-directory: integration
         run: bash ./run_its.sh
         env:
-          EXHORT_DEV_MODE: 'true'
+          TRUSTIFY_DA_DEV_MODE: 'true'
 
       - name: Upload coverage reports
         if: ${{ matrix.node == env.MAIN_NODE_VER }}

CONTRIBUTING.md

@@ -20,7 +20,7 @@
 
 ### Good to know
 
-* You can override the default backend url by setting another one in the _EXHORT_URL_ environment variable.
+* You can override the default backend url by setting another one in the _TRUSTIFY_DA_URL_ environment variable.
 
 ### OpenAPI Specifications
 
@@ -100,10 +100,10 @@ Run integration tests from the project's root:
 ```
 
 Integration tests are executed against a mocked _Backend_ server.<br/>
-If you need to run against the actual _Backend_ server, use the _EXHORT_ITS_USE_REAL_API_ environment variable:
+If you need to run against the actual _Backend_ server, use the _TRUSTIFY_DA_ITS_USE_REAL_API_ environment variable:
 
 ```shell
-(cd integration/ && EXHORT_ITS_USE_REAL_API=true bash ./run_its.sh)
+(cd integration/ && TRUSTIFY_DA_ITS_USE_REAL_API=true bash ./run_its.sh)
 ```
 
 The mocked server implementation is [integration/server/mock_server.js](integration/server/mock_server.js). See the

README.md

@@ -300,18 +300,18 @@ import exhort from '@trustify-da/trustify-da-javascript-client'
 import fs from 'node:fs'
 
 let options = {
-  'EXHORT_MVN_PATH': '/path/to/my/mvn',
-  'EXHORT_NPM_PATH': '/path/to/npm',
-  'EXHORT_PNPM_PATH': '/path/to/pnpm',
-  'EXHORT_GO_PATH': '/path/to/go',
+  'TRUSTIFY_DA_MVN_PATH': '/path/to/my/mvn',
+  'TRUSTIFY_DA_NPM_PATH': '/path/to/npm',
+  'TRUSTIFY_DA_PNPM_PATH': '/path/to/pnpm',
+  'TRUSTIFY_DA_GO_PATH': '/path/to/go',
   //python - python3, pip3 take precedence if python version > 3 installed
-  'EXHORT_PYTHON3_PATH' : '/path/to/python3',
-  'EXHORT_PIP3_PATH' : '/path/to/pip3',
-  'EXHORT_PYTHON_PATH' : '/path/to/python',
-  'EXHORT_PIP_PATH' : '/path/to/pip',
-  'EXHORT_GRADLE_PATH' : '/path/to/gradle',
+  'TRUSTIFY_DA_PYTHON3_PATH' : '/path/to/python3',
+  'TRUSTIFY_DA_PIP3_PATH' : '/path/to/pip3',
+  'TRUSTIFY_DA_PYTHON_PATH' : '/path/to/python',
+  'TRUSTIFY_DA_PIP_PATH' : '/path/to/pip',
+  'TRUSTIFY_DA_GRADLE_PATH' : '/path/to/gradle',
   // Configure proxy for all requests
-  'EXHORT_PROXY_URL': 'http://proxy.example.com:8080'
+  'TRUSTIFY_DA_PROXY_URL': 'http://proxy.example.com:8080'
 }
 
 // Get stack analysis in JSON format ( all package managers, pom.xml is as an example here)
@@ -333,13 +333,13 @@ You can set the proxy URL in two ways:
 
 1. Using environment variable:
 ```shell
-export EXHORT_PROXY_URL=http://proxy.example.com:8080
+export TRUSTIFY_DA_PROXY_URL=http://proxy.example.com:8080
 ```
 
 2. Using the options object when calling the API programmatically:
 ```javascript
 const options = {
-  'EXHORT_PROXY_URL': 'http://proxy.example.com:8080'
+  'TRUSTIFY_DA_PROXY_URL': 'http://proxy.example.com:8080'
 }
 ```
 
@@ -362,62 +362,62 @@ following keys for setting custom paths for the said executables.
 <tr>
 <td><a href="https://maven.apache.org/">Maven</a></td>
 <td><em>mvn</em></td>
-<td>EXHORT_MVN_PATH</td>
+<td>TRUSTIFY_DA_MVN_PATH</td>
 </tr>
 <tr>
 <td><a href="https://maven.apache.org/">Maven</a></td>
 <td><em>maven</em></td>
-<td>EXHORT_PREFER_MVNW</td>
+<td>TRUSTIFY_DA_PREFER_MVNW</td>
 </tr>
 <tr>
 <td><a href="https://www.npmjs.com/">NPM</a></td>
 <td><em>npm</em></td>
-<td>EXHORT_NPM_PATH</td>
+<td>TRUSTIFY_DA_NPM_PATH</td>
 </tr>
 <tr>
 <td><a href="https://pnpm.io/">PNPM</a></td>
 <td><em>pnpm</em></td>
-<td>EXHORT_PNPM_PATH</td>
+<td>TRUSTIFY_DA_PNPM_PATH</td>
 </tr>
 <tr>
 <td><a href="https://classic.yarnpkg.com/">Yarn Classic</a> / <a href="https://yarnpkg.com/">Yarn Berry</a></td>
 <td><em>yarn</em></td>
-<td>EXHORT_YARN_PATH</td>
+<td>TRUSTIFY_DA_YARN_PATH</td>
 </tr>
 <tr>
 <td><a href="https://go.dev/blog/using-go-modules/">Go Modules</a></td>
 <td><em>go</em></td>
-<td>EXHORT_GO_PATH</td>
+<td>TRUSTIFY_DA_GO_PATH</td>
 </tr>
 <tr>
 <td><a href="https://www.python.org/">Python programming language</a></td>
 <td><em>python3</em></td>
-<td>EXHORT_PYTHON3_PATH</td>
+<td>TRUSTIFY_DA_PYTHON3_PATH</td>
 </tr>
 <tr>
 <td><a href="https://pypi.org/project/pip/">Python pip Package Installer</a></td>
 <td><em>pip3</em></td>
-<td>EXHORT_PIP3_PATH</td>
+<td>TRUSTIFY_DA_PIP3_PATH</td>
 </tr>
 <tr>
 <td><a href="https://www.python.org/">Python programming language</a></td>
 <td><em>python</em></td>
-<td>EXHORT_PYTHON_PATH</td>
+<td>TRUSTIFY_DA_PYTHON_PATH</td>
 </tr>
 <tr>
 <td><a href="https://pypi.org/project/pip/">Python pip Package Installer</a></td>
 <td><em>pip</em></td>
-<td>EXHORT_PIP_PATH</td>
+<td>TRUSTIFY_DA_PIP_PATH</td>
 </tr>
 <tr>
 <td><a href="https://gradle.org/">Gradle</a></td>
 <td><em>gradle</em></td>
-<td>EXHORT_GRADLE_PATH</td>
+<td>TRUSTIFY_DA_GRADLE_PATH</td>
 </tr>
 <tr>
 <td><a href="https://gradle.org/">Gradle</a></td>
 <td><em>gradle</em></td>
-<td>EXHORT_PREFER_GRADLEW</td>
+<td>TRUSTIFY_DA_PREFER_GRADLEW</td>
 </tr>
 </table>
 
@@ -462,7 +462,7 @@ The MVS-based resolution is **enabled by default**.
 If you want to disable this behavior and instead include **all transitive module versions** (as listed in `go.mod` dependencies), set the system property or environment variable:
 
 ```bash
-EXHORT_GO_MVS_LOGIC_ENABLED=false
+TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED=false
 ```
 
 #### Python Support
@@ -471,32 +471,32 @@ By default, For python support, the api assumes that the package is installed us
 Binaries passed to environment variables. In any case, If the package is not installed , then an error will be thrown.
 
 There is an experimental feature of installing the requirements.txt on a virtual env(only python3 or later is supported for this feature) - in this case,
-it's important to pass in a path to python3 binary as `EXHORT_PYTHON3_PATH` or instead make sure that python3 is on the system path.
-in such case, You can use that feature by setting environment variable `EXHORT_PYTHON_VIRTUAL_ENV` to true.
+it's important to pass in a path to python3 binary as `TRUSTIFY_DA_PYTHON3_PATH` or instead make sure that python3 is on the system path.
+in such case, You can use that feature by setting environment variable `TRUSTIFY_DA_PYTHON_VIRTUAL_ENV` to true.
 
 ##### "Best Efforts Installation"
 Since Python pip packages are very sensitive/picky regarding python version changes( every small range of versions is only tailored for a certain python version), I'm introducing this feature, that
 tries to install all packages in requirements.txt onto created virtual environment while **disregarding** versions declared for packages in requirements.txt.
 This increasing the chances and the probability that the automatic installation will succeed.
 
 ###### Usage
-A New setting is introduced - `EXHORT_PYTHON_INSTALL_BEST_EFFORTS` (as both env variable/key in `options` object)
-1. `EXHORT_PYTHON_INSTALL_BEST_EFFORTS`="false" - install requirements.txt while respecting declared versions for all packages.
-2. `EXHORT_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set setting `MATCH_MANIFEST_VERSIONS` to 'false'.
+A New setting is introduced - `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS` (as both env variable/key in `options` object)
+1. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="false" - install requirements.txt while respecting declared versions for all packages.
+2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set setting `MATCH_MANIFEST_VERSIONS` to 'false'.
 
 ##### Using `pipdeptree`
 By default, The API algorithm will use native commands of PIP installer as data source to build the dependency tree.
-It's also possible to use the lightweight Python PIP utility [pipdeptree](https://pypi.org/project/pipdeptree/) as data source instead. In order to activate this, you need to set the environment variable/option `EXHORT_PIP_USE_DEP_TREE` to 'true'.
+It's also possible to use the lightweight Python PIP utility [pipdeptree](https://pypi.org/project/pipdeptree/) as data source instead. In order to activate this, you need to set the environment variable/option `TRUSTIFY_DA_PIP_USE_DEP_TREE` to 'true'.
 
 #### Toggle Red Hat Trusted Content recommendations
-Both the HTML-based report and JSON response will by default contain recommendations for migrating to Red Hat-based Trusted Content repositories. This feature can be disabled by setting `EXHORT_RECOMMENDATIONS_ENABLED` to 'false' via environment variables or options.
+Both the HTML-based report and JSON response will by default contain recommendations for migrating to Red Hat-based Trusted Content repositories. This feature can be disabled by setting `TRUSTIFY_DA_RECOMMENDATIONS_ENABLED` to 'false' via environment variables or options.
 
 #### Additional CLI arguments
 For some ecosystems we support passing additional CLI arguments to the underlying tools. The following table outlines the supported ecosystems and the environment variable/option that configures this. Note that the arguments are expected to be in the format of a JSON array.
 
 |Ecosystem|Key            |
 |---------|---------------|
-|Maven    |EXHORT_MVN_ARGS|
+|Maven    |TRUSTIFY_DA_MVN_ARGS|
 
 
 <!-- Badge links -->
@@ -506,7 +506,7 @@ For some ecosystems we support passing additional CLI arguments to the underlyin
 ### Known Issues
 
 - For pip requirements.txt - It's been observed that for python versions 3.11.x, there might be slowness for invoking the analysis.
-  If you encounter a performance issue with version >= 3.11.x, kindly try to set environment variable/option `EXHORT_PIP_USE_DEP_TREE=true`, before calling the analysis.
+  If you encounter a performance issue with version >= 3.11.x, kindly try to set environment variable/option `TRUSTIFY_DA_PIP_USE_DEP_TREE=true`, before calling the analysis.
 
 
 - For maven pom.xml, it has been noticed that using java 17 might cause stack analysis to hang forever.

config/config.properties

@@ -1 +1 @@
-EXHORT_DEV_MODE=false
+TRUSTIFY_DA_DEV_MODE=false

docker-image/Dockerfiles/Dockerfile

@@ -6,7 +6,7 @@ USER root
 
 # assign token for reading packages from github package registry
 ARG PACKAGE_REGISTRY_ACCESS_TOKEN=''
-ARG EXHORT_JAVASCRIPT_API_VERSION='0.1.1-ea.55'
+ARG TRUSTIFY_DA_JAVASCRIPT_API_VERSION='0.1.1-ea.55'
 
 # install Java
 RUN curl -kL https://download.oracle.com/java/21/archive/jdk-21.0.1_linux-x64_bin.tar.gz -o /tmp/java-package.tar.gz \
@@ -28,7 +28,7 @@ COPY configs/.npmrc .
 # replace placeholder with the actual environment variable
 RUN sed -i "s/__PACKAGE_REGISTRY_ACCESS_TOKEN__/${PACKAGE_REGISTRY_ACCESS_TOKEN}/g" ./.npmrc
 # install Exhort javascript API
-RUN npm install --global @trustify-da/trustify-da-javascript-client@${EXHORT_JAVASCRIPT_API_VERSION}
+RUN npm install --global @trustify-da/trustify-da-javascript-client@${TRUSTIFY_DA_JAVASCRIPT_API_VERSION}
 
 # add RHDA script
 COPY scripts/rhda.sh /rhda.sh
@@ -52,11 +52,11 @@ LABEL org.opencontainers.image.source=https://github.com/guacsec/trustify-da-jav
 # assign rhda source for exhort tracking purposes
 ENV RHDA_SOURCE=''
 # contains pip feeze --all data, base64 encoded
-ENV EXHORT_PIP_FREEZE=''
+ENV TRUSTIFY_DA_PIP_FREEZE=''
 # contains pip show data for all packages, base64 encoded
-ENV EXHORT_PIP_SHOW=''
+ENV TRUSTIFY_DA_PIP_SHOW=''
 # indicate whether to use the Minimal version selection (MVS) algorithm to select a set of module versions to use when building Go packages.
-ENV EXHORT_GO_MVS_LOGIC_ENABLED='true'
+ENV TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED='true'
 
 # Copy java executable from the builder stage
 COPY --from=builder /usr/jdk-21.0.1/ /usr/jdk-21.0.1/

docker-image/README.md

@@ -20,7 +20,7 @@ Maven, NPM, Golang   | mvn 3.9.6, <br>npm 10.2.4, <br>go 1.21.5, <br>python \<an
 
 ## Usage Notes
 
-To perform RHDA analysis on a **Python** ecosystem, the data from both `pip freeze --all` and `pip show` commands should be generated for all packages listed in the requirements.txt manifest. This data should be encoded in base64 and passed through the `EXHORT_PIP_FREEZE` and `EXHORT_PIP_SHOW` environment variables, respectively.
+To perform RHDA analysis on a **Python** ecosystem, the data from both `pip freeze --all` and `pip show` commands should be generated for all packages listed in the requirements.txt manifest. This data should be encoded in base64 and passed through the `TRUSTIFY_DA_PIP_FREEZE` and `TRUSTIFY_DA_PIP_SHOW` environment variables, respectively.
 Code example:
 ``` shell
 # Install requirements.txt
@@ -34,6 +34,6 @@ SHOW_LIST=$(awk -F '==' '{print $1}' < pip_freeze.txt)
 pip3 show $(echo "$SHOW_LIST") > pip_show.txt
 
 # Encode data using base64 and export to environment variables
-export EXHORT_PIP_FREEZE=$(cat pip_freeze.txt | base64 -w 0)
-export EXHORT_PIP_SHOW=$(cat pip_show.txt | base64 -w 0)
+export TRUSTIFY_DA_PIP_FREEZE=$(cat pip_freeze.txt | base64 -w 0)
+export TRUSTIFY_DA_PIP_SHOW=$(cat pip_show.txt | base64 -w 0)
 ```

integration/run_its.sh

@@ -2,8 +2,8 @@
 
 #!!!!! DO NOT FORGET 'npm run compile' on root prior to running this script !!!!#
 
-# set EXHORT_ITS_USE_REAL_API=true to use the real backend
-EXHORT_ITS_USE_REAL_API="${EXHORT_ITS_USE_REAL_API:=false}"
+# set TRUSTIFY_DA_ITS_USE_REAL_API=true to use the real backend
+TRUSTIFY_DA_ITS_USE_REAL_API="${TRUSTIFY_DA_ITS_USE_REAL_API:=false}"
 
 # utility function for wrapping up and exiting
 # takes an exit code

integration/testers/javascript/index.js

@@ -22,7 +22,7 @@ if ('component' === args[0]) {
 if ('validateToken' === args[0]) {
 	// args[1] - the token passed
 	let tokens = {
-		"EXHORT_SNYK_TOKEN" : args[1]
+		"TRUSTIFY_DA_SNYK_TOKEN" : args[1]
 	}
 	let res = await exhort.validateToken(tokens)
 	console.log(res)

package.json

@@ -32,8 +32,6 @@
 		"lint": "eslint src test --ext js",
 		"lint:fix": "eslint src test --ext js --fix",
 		"test": "c8 npm run tests",
-		"localtest": "EXHORT_PIP3_PATH=/home/zgrinber/python3.9/bin/pip3 EXHORT_PYTHON3_PATH=/home/zgrinber/python3.9/bin/python3 c8 npm run tests",
-		"postlocaltest": " git status | grep src/providers/ | grep rewire | xargs -i git clean -f {}",
 		"tests": "mocha --config .mocharc.json --grep \"Integration Tests|.*analysis module.*\" --invert",
 		"tests:rep": "mocha --reporter-option maxDiffSize=0 --reporter json > unit-tests-result.json",
 		"integration-tests": "mocha --grep \"Integration Tests\"",