Fix workflow. Cleanup. Add license headers. Also, update README.md

.github/workflows/helm-build-chart.yml

@@ -6,10 +6,6 @@ on:
     branches: [main]
   workflow_dispatch:
 
-env:
-  API_KEY: changeme
-  OPENVASD: 127.0.0.1:8080
-
 jobs:
   openvasd:
     runs-on: ubuntu-latest
@@ -35,6 +31,10 @@ jobs:
           kubectl --namespace default port-forward ${{ steps.smoketest.outputs.POD_NAME }} 8080:3000 &
       - name: smoketest
         working-directory: rust/smoketest
+        env:
+          API_KEY: changeme
+          OPENVASD: http://127.0.0.1:8080
+          SCAN_CONFIG: simple_scan_ssh_only.json
         run: |
           make build run
       - uses: greenbone/actions/helm-build-push@v3

.github/workflows/rustification.yaml

@@ -24,7 +24,8 @@ jobs:
       - uses: actions/checkout@v4
       - run: sudo apt update && sudo apt-get install -y libpcap-dev
       - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} || rustup default ${{ matrix.toolchain }}
-      - run: cargo test
+      # Run unittests and integration test, but excludes the smoketest since it depends on a running openvasd server.
+      - run: cargo test --lib --tests --workspace --exclude smoketest
   clippy:
     runs-on: ubuntu-latest
     defaults:

rust/models/src/host_info.rs

@@ -22,10 +22,6 @@ pub struct HostInfo {
     pub queued: u32,
     /// Number of hosts, that are already finished scanning
     pub finished: u32,
-    #[cfg_attr(
-        feature = "serde_support",
-        serde(skip_serializing_if = "Option::is_none")
-    )]
     /// IPs of hosts, that are currently scanned.
-    pub scanning: Option<Vec<String>>,
+    pub scanning: Vec<String>,
 }

rust/osp/src/response.rs

@@ -613,7 +613,7 @@ impl From<Scan> for models::Status {
                     - i.count_alive.content.0
                     - i.host.len() as u32,
                 finished: i.count_alive.content.0,
-                scanning: Some(scanning),
+                scanning,
             }),
         }
     }

rust/smoketest/README.md

@@ -24,9 +24,10 @@ All settings for running the smoke-tests are set via environmental variables. Th
 |TARGET_USERNAME|Username for login in the target during the authenticated scan|empty string|no|Necessary for authenticated scans|
 |TARGET_PASSWORD|Password for login in the target during the authenticated scan|empty string|no|Necessary for authenticated scans|
 |API_KEY|API Key for authenticated communication with `openvasd`|mtls_is_preferred|yes||
-|OPENVASD|Socket where openvasd listen on|127.0.0.1:3000|no|Must be specified with port|
+|OPENVASD|Socket where openvasd listen on|http://127.0.0.1:3000|no|Must be specified with port|
 |CLIENT_CERT|PEM file combinating public certificate and any 3rd party intermediate certificates ||yes for mTLS|Necessary for mTLS enabled|
 |CLIENT_KEY|Client private key||yes for mTLS|Necessary for mTLS enabled|
+|SCAN_CONFIG|Scan config in json file format to be run against the target|simple_scan_ssh_only.json|yes||
 
 
 ## Usage

rust/smoketest/src/config.rs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Greenbone AG
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
 use std::env;
 
 #[derive(Debug)]

rust/smoketest/src/lib.rs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Greenbone AG
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
 pub mod config;
 use models::{Phase, Result as ScanResult, Status};
 use reqwest::header;
@@ -74,12 +78,12 @@ pub async fn create_scan(
 pub async fn scan_action(
     cli: &reqwest::Client,
     server: &String,
-    id: &String,
+    id: &str,
     action: String,
 ) -> bool {
     let mut path = String::from(server);
     path.push_str("/scans/");
-    path.push_str(id.as_str());
+    path.push_str(id);
 
     let mut data = HashMap::new();
     data.insert("action", action.as_str());
@@ -95,10 +99,10 @@ pub async fn scan_action(
 }
 
 /// Given an ScanID, it fetches the current scan status.
-pub async fn scan_status(cli: &reqwest::Client, server: &String, id: &String) -> Option<Phase> {
+pub async fn scan_status(cli: &reqwest::Client, server: &String, id: &str) -> Option<Phase> {
     let mut path = String::from(server);
     path.push_str("/scans/");
-    path.push_str(id.as_str());
+    path.push_str(id);
     path.push_str("/status");
 
     let res = cli.get(path).send().await.unwrap();
@@ -127,11 +131,11 @@ pub async fn scan_status(cli: &reqwest::Client, server: &String, id: &String) ->
 pub async fn scan_results(
     cli: &reqwest::Client,
     server: &String,
-    id: &String,
+    id: &str,
 ) -> Option<Vec<ScanResult>> {
     let mut path = String::from(server);
     path.push_str("/scans/");
-    path.push_str(id.as_str());
+    path.push_str(id);
     path.push_str("/results");
 
     let res = cli.get(path).send().await.unwrap();
@@ -156,10 +160,10 @@ pub async fn scan_results(
     None
 }
 
-pub async fn delete_scan(cli: &reqwest::Client, server: &String, id: &String) -> bool {
+pub async fn delete_scan(cli: &reqwest::Client, server: &String, id: &str) -> bool {
     let mut path = String::from(server);
     path.push_str("/scans/");
-    path.push_str(id.as_str());
+    path.push_str(id);
 
     let res = cli.delete(path).send().await.unwrap();
 

rust/smoketest/tests/tests.rs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Greenbone AG
+//
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
 pub mod tests {
     use models::Phase;
     use smoketest::*;
@@ -42,7 +46,6 @@ pub mod tests {
             loop {
                 match scan_status(&cli, args.openvasd(), &id).await {
                     Some(Phase::Succeeded) => {
-                        tracing::info!("\tRun scan succeeded OK");
                         if let Some(results) = scan_results(&cli, args.openvasd(), &id).await {
                             assert_eq!(results.is_empty(), false)
                         }
@@ -54,8 +57,8 @@ pub mod tests {
                         success = false;
                         break;
                     }
-                    _ => {
-                        std::thread::sleep(std::time::Duration::from_secs(10));
+                    Some(_) => {
+                        std::thread::sleep(std::time::Duration::from_secs(1));
                         counter += 1;
                         assert!(counter <= 360);
                     }
@@ -64,5 +67,4 @@ pub mod tests {
         }
         assert!(success)
     }
-
 }