Working Test Client (#1)

Author: MJHC

.dockerignore

@@ -0,0 +1,2 @@
+target
+.git

.github/workflows/docker.yml

@@ -0,0 +1,52 @@
+name: Create and publish SAM/DenIM-on-SAM Test Client
+
+on:
+  push:
+    branches: ["main"]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GHCR_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

.gitignore

@@ -14,4 +14,14 @@ target/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+# Added by cargo
+
+/target
+
+*.sql
+*.crt
+*.key
+*.json
+Cargo.lock

Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "test-client"
+version = "0.1.0"
+edition = "2024"
+repository = "https://github.com/SAM-Research/test-client"
+
+[dependencies]
+denim-sam-client = { git = "https://github.com/SAM-Research/denim-on-sam.git", branch = "main" }
+denim-sam-common = { git = "https://github.com/SAM-Research/denim-on-sam.git", branch = "main" }
+sam-client = { git = "https://github.com/SAM-Research/sam-instant-messenger.git", branch = "main" }
+sam-common = { git = "https://github.com/SAM-Research/sam-instant-messenger.git", branch = "main" }
+sam-net = { git = "https://github.com/SAM-Research/sam-instant-messenger.git", branch = "main" }
+tokio = { version = "1.40.0", features = ["full"] }
+reqwest = { version = "0.12.12", features = ["cookies"] }
+serde = { version = "1.0.210" }
+serde_with = { version = "3.11.0" }
+derive_more = { version = "2.0.1" }
+async-trait = "0.1.83"
+serde_json = "1.0.139"
+bon = "3.3.2"
+rustls = "0.23.15"
+env_logger = "0.11.6"
+rand = "0.8.5"
+log = "0.4.25"
+clap = "4.5.32"

README.md

@@ -1 +1,19 @@
 # Denim SAM Test client
+
+# SAM Dependencies
+
+to update sam dependencies just do:
+
+```sh
+cargo update -p sam-server
+```
+
+you might need to change `sam-server` to either one of the other sam projects
+
+# Docker
+
+Building the `test-client` docker image:
+
+```sh
+docker build -t test-client .
+```

config.json

@@ -0,0 +1,7 @@
+{
+  "address": "127.0.0.1:4443",
+  "dispatchAddress": "127.0.0.1:8080",
+  "certificatePath": "./root.crt",
+  "channelBufferSize": 10,
+  "logging": "info"
+}

dockerfile

@@ -0,0 +1,21 @@
+FROM rust:1.86-slim AS builder
+ENV SQLX_OFFLINE=true
+WORKDIR /test-client
+COPY . .
+
+RUN apt update 
+RUN apt install -y protobuf-compiler pkg-config libssl-dev
+
+RUN cargo build --release
+
+LABEL org.opencontainers.image.source=https://github.com/SAM-Research/test-client
+LABEL org.opencontainers.image.description="SAM/DenIM-on-SAM Test Client image"
+LABEL org.opencontainers.image.licenses=MIT
+
+
+FROM debian:bookworm-slim
+RUN apt update && apt install -y libssl3 ca-certificates && rm -rf /var/lib/apt/lists/*
+COPY --from=builder /test-client/target/release/test-client /test-client
+
+
+ENTRYPOINT ["/test-client"]

src/config.rs

@@ -0,0 +1,13 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DenimClientConfig {
+    pub address: String,
+    pub dispatch_address: String,
+    pub certificate_path: Option<String>,
+
+    pub channel_buffer_size: Option<usize>,
+
+    pub logging: Option<String>,
+}

src/data.rs

@@ -0,0 +1,98 @@
+use sam_common::AccountId;
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct Friend {
+    pub username: String,
+    pub frequency: f64,
+    pub denim: bool,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct ClientInfo {
+    pub client_type: ClientType,
+    pub username: String,
+    pub message_size_range: (u32, u32),
+    pub send_rate: u32,
+    pub tick_millis: u32,
+    pub duration_ticks: u32,
+    pub denim_probability: f32,
+    pub friends: HashMap<String, Friend>,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "lowercase")]
+pub enum ClientType {
+    Denim,
+    Sam,
+    #[serde(other)]
+    Other,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "lowercase")]
+pub enum MessageType {
+    Denim,
+    Regular,
+    #[serde(other)]
+    Other,
+}
+
+#[derive(Serialize, Deserialize, Clone, bon::Builder, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct MessageLog {
+    #[serde(rename = "type")]
+    pub r#type: MessageType,
+    pub from: String,
+    pub to: String,
+    pub size: usize,
+    pub tick: u32,
+}
+
+#[derive(Serialize, Deserialize, Clone, bon::Builder, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct ClientReport {
+    pub start_time: u64,
+    pub messages: Vec<MessageLog>,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct StartInfo {
+    pub friends: HashMap<String, AccountId>,
+}
+
+#[derive(Serialize, Deserialize, Clone, bon::Builder, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct AccountInfo {
+    pub account_id: AccountId,
+}
+
+#[derive(Serialize, Deserialize, Clone, bon::Builder, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct HealthCheck {
+    pub sam: String,
+    pub denim: Option<String>,
+    pub database: String,
+}
+
+impl HealthCheck {
+    pub fn is_ok(&self) -> bool {
+        let status = vec![&self.sam, &self.database];
+        let is_ok = status.iter().all(|f| *f == "OK");
+        is_ok && self.denim.as_ref().is_some_and(|x| x == "OK")
+    }
+}
+
+pub struct DispatchData {
+    pub client: ClientInfo,
+    pub start: StartInfo,
+}
+
+impl DispatchData {
+    pub fn new(client: ClientInfo, start: StartInfo) -> Self {
+        Self { client, start }
+    }
+}

src/dispatch.rs

@@ -0,0 +1,77 @@
+use crate::data::{AccountInfo, ClientInfo, ClientReport, StartInfo};
+use derive_more::{Display, Error, From};
+
+pub struct SamDispatchClient {
+    url: String,
+    client: reqwest::Client,
+}
+
+#[derive(Debug, Display, Error, From)]
+pub enum SamDispatchError {
+    Json(serde_json::Error),
+    Reqwest(reqwest::Error),
+    Unauthorized,
+}
+
+impl SamDispatchClient {
+    pub fn new(url: String) -> Result<Self, SamDispatchError> {
+        Ok(Self {
+            url: format!("http://{}", url),
+            client: reqwest::Client::builder().cookie_store(true).build()?,
+        })
+    }
+
+    pub async fn health(&self) -> bool {
+        let res = self.client.get(format!("{}/health", self.url)).send().await;
+        match res {
+            Ok(r) => r.status().is_success(),
+            Err(_) => false,
+        }
+    }
+
+    pub async fn get_client(&self) -> Result<ClientInfo, SamDispatchError> {
+        let res = self
+            .client
+            .get(format!("{}/client", self.url))
+            .send()
+            .await?;
+
+        Ok(res.json().await?)
+    }
+
+    pub async fn sync(&self) -> Result<StartInfo, SamDispatchError> {
+        let res = self.client.get(format!("{}/sync", self.url)).send().await?;
+        if res.status() == reqwest::StatusCode::UNAUTHORIZED {
+            return Err(SamDispatchError::Unauthorized);
+        }
+        Ok(res.json().await?)
+    }
+
+    pub async fn upload_results(&self, report: ClientReport) -> Result<(), SamDispatchError> {
+        let json_val = serde_json::to_string(&report)?;
+        let res = self
+            .client
+            .post(format!("{}/upload", self.url))
+            .body(json_val)
+            .send()
+            .await?;
+        if res.status() == reqwest::StatusCode::UNAUTHORIZED {
+            return Err(SamDispatchError::Unauthorized);
+        }
+        Ok(())
+    }
+
+    pub async fn upload_account_id(&self, account_id: AccountInfo) -> Result<(), SamDispatchError> {
+        let json_val = serde_json::to_string(&account_id)?;
+        let res = self
+            .client
+            .post(format!("{}/id", self.url))
+            .body(json_val)
+            .send()
+            .await?;
+        if res.status() == reqwest::StatusCode::UNAUTHORIZED {
+            return Err(SamDispatchError::Unauthorized);
+        }
+        Ok(())
+    }
+}