Refactored web-ui ENV and apply-headers.sh

Author: lorriborri

apply-headers.sh

@@ -3,6 +3,21 @@
 
 SPDX_TEXT="SPDX-License-Identifier: MIT"
 
+# List of files to exclude
+exclude_files=("auto-imports.d.ts" "components.d.ts" "typed-router.d.ts")
+
+# Function to check if a file is in the exclude list
+function is_excluded() {
+  local file=$1
+  filename=$(basename "$file")
+  for excluded in "${exclude_files[@]}"; do
+    if [[ "$filename" == "$excluded" ]]; then
+      return 0
+    fi
+  done
+  return 1
+}
+
 function isColoredTerminal(){
     # check if stdout is a terminal...
     if test -t 1; then
@@ -29,12 +44,16 @@ function applySPDXline {
     echo -e "  ${LIGHT_GREEN}Scanning '*.$fileEnding' files${NC}"
     # Loop over all files matching the pattern, but skip some patterns like generated files
     find . -type f -iname \*.$fileEnding \
-    | grep -v '^./.git\|/build/\|/\.gradle/\|gradlew.bat\|sechub-cli/pkg/mod\|sechub-cli/src/mercedes-benz.com/sechub/pkg/mod/' \
+    | grep -v '^./.git\|/build/\|/node_modules/\|/\.gradle/\|gradlew.bat\|sechub-cli/pkg/mod\|sechub-cli/src/mercedes-benz.com/sechub/pkg/mod/' \
     | while read file ; do
+      if ! is_excluded "$file"; then
         if ! grep -q "$SPDX_TEXT" $file ; then
             sed -i "${line}i $spdxMessage" "$file"
             echo -e "${BROWN}$file${NC} - ${LIGHT_GREEN}copyright appended.${NC}"
         fi
+      else
+          echo "Skipping excluded file: $file"
+      fi
     done
 }
 
@@ -98,7 +117,6 @@ applySPDXonFirstLine "sql" "-- $SPDX_TEXT"
 applySPDXonFirstLine "yaml" "# $SPDX_TEXT"
 applySPDXonFirstLine "yml" "# $SPDX_TEXT"
 applySPDXonFirstLine "ts" "// $SPDX_TEXT"
-applySPDXonFirstLine "d.ts" "// $SPDX_TEXT"
 applySPDXonFirstLine "vue" "<!-- $SPDX_TEXT -->"
 
 

sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/model/login/WebLoginVerificationConfiguration.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.commons.model.login;
 
 import java.net.URL;

sechub-commons-model/src/test/java/com/mercedesbenz/sechub/commons/model/login/WebLoginVerificationConfigurationTest.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.commons.model.login;
 
 import static org.junit.jupiter.api.Assertions.*;

sechub-doc/src/main/java/com/mercedesbenz/sechub/docgen/ConfigurationPropertiesData.java

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: MIT
 package com.mercedesbenz.sechub.docgen;
 
 import java.lang.reflect.Constructor;

sechub-web-ui-solution/README.adoc

@@ -14,26 +14,23 @@ remove the root `redirect / to login page` if you do not have login enabled in t
 
 2. Adjust the docker/nginx/config.json to your needs: +
 +
-If you do not have login enabled, you can set basic auth for the Web-UI in the config.json file. +
+If you do not have login enabled, you can set basic auth for the Web-UI in the config.json file. in docker/nginx/ +
+The values can be changed at runtime +
 +
 .ENV that can be set in the config.json file
 |===
 |Name |Default Value |Description
 
-|HOST
-|http://localhost
-|The URL of the Web-UI (used as API Endpoint to prevent CORS issues)
-
-|LOCAL_DEV
+|BASIC_AUTH_DEV
 |false
 |Sets Basic Auth for the Web-UI (only for development, username and password must be set)
 
 |USERNAME
-|''
+|undefined
 |Basic Auth username (only for development)
 
 |PASSWORD
-|''
+|undefined
 |Basic Auth password (only for development)
 |===
 

sechub-web-ui-solution/docker/nginx/config.json

@@ -1,3 +1,2 @@
 {
-  "HOST": "https://localhost"
 }

sechub-web-ui/README.md

@@ -3,7 +3,7 @@
 
 This project is a web application that provides a user interface for the SecHub API. It is built with [Vite](https://vitejs.dev/), [Vue 3](https://v3.vuejs.org/), and [Vuetify](https://vuetifyjs.com/en/).
 
-## Usage
+## Prequisites
 
 ### Installation
 
@@ -24,17 +24,6 @@ Install the project dependencies:
 npm install
 ```
 
-### Create a local configuration (.env)
-
-Create a `.env` file in the sechub-webui directory
-
-```bash
-VITE_API_HOST=http://localhost:3000
-VITE_API_USER=<your-api-user>
-VITE_API_PASSWORD=<your-api-password>
-VITE_API_LOCAL_DEV=true
-```
-
 ### Building openAPI SecHub Client
 
 To generate the SecHub openAPI Client use:
@@ -43,25 +32,45 @@ To generate the SecHub openAPI Client use:
 npm run generate-api-client
  ```
 
-### Starting the Development Server
+## Usage
+
+### Running local development server with SecHub Integrationtest Server
+
+#### Create a local configuration (.env) with Basic Auth 
+
+Create a `.env` file in the sechub-webui directory
+
+```bash
+VITE_API_USERNAME=<your-api-user>
+VITE_API_PASSWORD=<your-api-password>
+VITE_API_BASIC_AUTH_DEV=true
+```
+
+#### Start the Development Server
 
 To start the development server with hot-reload, run the following command. The server will be accessible at [http://localhost:3000](http://localhost:3000):
 
 ```bash
 npm run dev
 ```
 
-#### Running in Development mode with SecHub Integrationtest Server and PDS Integrationtest Server (using Mocked scan products)
+#### Start SecHub Integrationtest Server
+
+If you want to get Server responses, start the SecHub integrationtest Server e.g. via your IDE see the [developer guide](https://mercedes-benz.github.io/sechub/latest/sechub-developer-quickstart-guide.html#run-integration-tests-from-ide) for instructions.
+Use the SecHub user and password for your basic auth .env file.
+You can use the sechub-api.sh script to manage your user and project.
+
+### Running local development server with SecHub Integrationtest Server and PDS Integrationtest Server (Mocked Products)
 > Only useful If you want to get mocked scan results
-1. Follow the steps above
+1. Follow all steps above
 2. Start the integration test PDS  
 (for the correct run configuration follow the [developer guide](https://mercedes-benz.github.io/sechub/latest/sechub-developer-quickstart-guide.html#run-integration-tests-from-ide))
-3. (Optional) Initial setup: execute /test-setups/setup-integration-test-server.sh
+3. (Optional) Initial setup: execute `test-setups/setup-integration-test-server.sh`. Make sure the .env file contains the correct values for basic auth.
 
-#### Running in Development mode with SecHub Server and PDS as Docker Container
+### Running local development server with SecHub Docker Container and PDS Docker Container (Real Products)
 > Only useful If you want to get real scan results
 1. Start the SecHub Server as Docker Container (see sechub-solution/01-...)
-2. Start the required PDS as Docker (e.g. sechub-pds-solutions/gosec/05-...)
+2. Start the required PDS as Docker Container (e.g. sechub-pds-solutions/gosec/05-...)
 3. Set up PDS in sechub-solution/setups/ e.g. setup-gosec.sh
 4. Make sure your user is assigned to the project you want to scan