First commit

Author: reneca

.github/workflows/ci.yml

@@ -0,0 +1,84 @@
+---
+name: Rust
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+env:
+  RUSTFLAGS: -Dwarnings
+  RUST_BACKTRACE: 1
+  CARGO_TERM_COLOR: always
+
+permissions:
+  contents: read
+
+jobs:
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: clippy,rustc-dev
+      - run: >
+          cargo clippy --color always --verbose
+          --workspace --all-targets
+          --all-features --tests
+
+  fmt:
+    name: Rust fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: rustfmt
+      - run: cargo fmt -- --check
+
+  doc:
+    name: Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    env:
+      RUSTDOCFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: rustfmt
+      - run: cargo doc --color=always --verbose --no-deps
+
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: rustc-dev
+      - run: cargo check --benches --all-features --release
+
+  test:
+    name: Tests
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: llvm-tools, rustc-dev
+      - run: >
+          cargo test --all-features --release
+          --tests --verbose --color always
+          --workspace --no-fail-fast

.gitignore

@@ -0,0 +1,46 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Generated
+*.profraw
+*.json
+*.xml
+*.info
+*.html
+
+# IDE files
+.vscode/*
+.history/
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+.idea
+out/
+
+# OS files
+*.DS_Store
+
+# Packages
+*.tar
+*.tar.gz
+*.tar.xz

Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "prosa-fetcher"
+version = "0.1.0"
+authors = ["Jeremy HERGAULT"]
+license = "LGPL-3.0-or-later"
+edition = "2024"
+description = "ProSA processor to fetch information from remote systems"
+
+[package.metadata.prosa.fetcher]
+proc = "proc::FetcherProc"
+settings = "proc::FetcherSettings"
+
+[dependencies]
+bytes = "1"
+prosa = "0.2"
+prosa-utils = "0.2"
+serde = "1"
+tokio = "1"
+thiserror = "2"
+tracing = "0.1"
+url = { version = "2", features = ["serde"] }
+base64 = "0.22"
+hmac = "0.12"
+
+hyper = { version = "1", features = ["full"] }
+http = "1"
+http-body-util = "0.1"
+hyper-util = { version = "0.1", features = ["full"] }

README.md

@@ -0,0 +1,32 @@
+# ProSA Fetcher
+
+[ProSA](https://github.com/worldline/ProSA) processor to fetch information from remote systems.
+
+The main goal of this processor is to retrieve metrics periodically from remote systems.
+
+## Configuration
+
+For configuration, you can set either the `target`, or the `service_name` (or both), depending on your fetcher type.
+
+The `target` uses ProSA's [`TargetSetting`](https://docs.rs/prosa/latest/prosa/io/stream/struct.TargetSetting.html) to define all connection information.
+If you need to authenticate, you will have to set the user and password in the [url](https://docs.rs/url/latest/url/struct.Url.html#method.password).
+
+If you want to fetch an internal service, you only have to specify its name with `service_name`.
+
+An `auth_method` can also be set (not present in the following example), but generally, the auth method is known by the adaptor and will be set by it.
+
+The last two parameters, `period` and `timeout`, configure the interval between fetches and the timeout for each fetch, respectively.
+The timeout should be less than the period to ensure that only one fetch runs at a time.
+
+```yaml
+fetcher:
+  target:
+    url: "http://localhost"
+  service_name: "output_service"
+  period:
+    secs: 60
+    nanos: 0
+  timeout:
+    secs: 10
+    nanos: 0
+```

src/adaptor.rs

@@ -0,0 +1,63 @@
+use std::{convert::Infallible, future::ready};
+
+use http::Request;
+use http_body_util::combinators::BoxBody;
+use hyper::{
+    Response,
+    body::{Bytes, Incoming},
+};
+use prosa::core::adaptor::Adaptor;
+
+use crate::proc::{FetchAction, FetcherError, FetcherProc};
+
+/// Trait adaptor for the Fetcher processor.
+pub trait FetcherAdaptor<M>: Adaptor
+where
+    M: 'static
+        + std::marker::Send
+        + std::marker::Sync
+        + std::marker::Sized
+        + std::clone::Clone
+        + std::fmt::Debug
+        + prosa_utils::msg::tvf::Tvf
+        + std::default::Default,
+{
+    /// Method called when the processor spawns
+    /// This method is called only once so the processing will be thread safe
+    fn new(proc: &FetcherProc<M>) -> Result<Self, FetcherError<M>>
+    where
+        Self: std::marker::Sized;
+
+    /// Method that indicate what should be done to fetch informations from the remote system
+    fn fetch(&mut self) -> Result<FetchAction<M>, FetcherError<M>>;
+
+    /// Create an HTTP request to fetch information
+    fn create_http_request(
+        &self,
+        request_builder: http::request::Builder,
+    ) -> Result<Request<BoxBody<Bytes, Infallible>>, FetcherError<M>>;
+
+    /// Process http response
+    fn process_http_response(
+        &mut self,
+        _response: Response<Incoming>,
+    ) -> impl std::future::Future<Output = Result<FetchAction<M>, FetcherError<M>>> + Send {
+        ready(Ok(FetchAction::None))
+    }
+
+    /// Process service response
+    fn process_service_response(
+        &mut self,
+        _response: prosa::core::msg::ResponseMsg<M>,
+    ) -> Result<FetchAction<M>, FetcherError<M>> {
+        Ok(FetchAction::None)
+    }
+
+    /// Method to process incomings error received by the processor
+    fn process_service_error(
+        &self,
+        _error: prosa::core::msg::ErrorMsg<M>,
+    ) -> Result<FetchAction<M>, FetcherError<M>> {
+        Ok(FetchAction::None)
+    }
+}

src/lib.rs

@@ -0,0 +1,2 @@
+pub mod adaptor;
+pub mod proc;