Merge branch 'main' of github.com:0xMartin/NetworkAppTestingTool

.github/workflows/gradle.yml

@@ -0,0 +1,67 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Java CI with Gradle
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies.
+    # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
+    - name: Setup Gradle
+      uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+
+    - name: Build with Gradle Wrapper
+      run: ./gradlew build
+
+    # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
+    # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version.
+    #
+    # - name: Setup Gradle
+    #   uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+    #   with:
+    #     gradle-version: '8.5'
+    #
+    # - name: Build with Gradle 8.5
+    #   run: gradle build
+
+  dependency-submission:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
+    # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
+    - name: Generate and submit dependency graph
+      uses: gradle/actions/dependency-submission@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

README.md

@@ -9,7 +9,7 @@
   <i>Created as part of the thesis at UTB</i>
 </div>
 
-# 💡 Description of testing  tool
+# 💡 Description of testing tool
 
 This **Black Box** Testing Tool is designed for automating the testing and evaluation of tasks without requiring knowledge of the software's internal structure or implementation details. It offers several key features:
 
@@ -30,7 +30,7 @@ This **Black Box** Testing Tool is designed for automating the testing and evalu
 
 ## Supports running test on **localhost** or in **CI/CD** pipeline
 
-Basic CI/CD pipeline configuration with automatic test execution. The repository must contain the NATT.jar file as well as the configuration with the test suites.
+Basic GitLab CI/CD pipeline configuration with automatic test execution. The repository must contain the NATT.jar file as well as the configuration with the test suites.
 
 ```yaml
 image: gradle:alpine
@@ -192,7 +192,7 @@ This set encompasses keywords for working with variables, waiting, conditional w
    - `text`: *Type*: string | not required, *Description*: Text that must be included in the message. (default: "")
    - `tag`: *Type*: string | not required, *Description*: Required tag of the message. (default: "")
    - `mode`: *Type*: string | not required, *Description*: Finding mode. There are these modes: "equals", "contains", "startswith", "endswith". (default: equals)
-   - `case_sensitive | not required`: *Type*: boolean, *Description*: Whether the filter should be case sensitive.
+   - `case_sensitive`: *Type*: boolean, *Description*: Whether the filter should be case sensitive.
 4. **`count_and_store` - Counts the number of received messages during a single test case and saves this count into a variable.**
    - `var_name`: *Type*: string, *Description*: Variable to store the count.
    - `module_name`: *Type*: string, *Description*: Module whose received messages will be counted.
@@ -308,7 +308,7 @@ This set includes keywords that enable working with communication modules.
     - `text`: *Type*: string, *Description*: Text to filter on.
     - `tag`: *Type*: string | not required, *Description*: Tag of message. (default: "")
     - `mode`: *Type*: string | not required, *Description*: Filter mode. There are this modes: "equals", "contains", "startswith", "endswith". (default: equals)
-    - `case_sensitive | not required`: *Type*: boolean, *Description*: Whether the filter should be case sensitive. (default: true)
+    - `case_sensitive`: *Type*: boolean, *Description*: Whether the filter should be case sensitive. (default: true)
 12. **`clear_filter_actions` - Removes all action filters for a specific module.**
     - `default`: *Type*: string, *Description*: Name of module.