Add config for docker-building/-running up-subscription-cli (#5)

Author: AnotherDaniel

.dockerignore

@@ -0,0 +1 @@
+target

.github/workflows/README.md

@@ -28,11 +28,11 @@ This is implemented in [`nightly.yaml`](nightly.yaml)
 
 In addition to the main workflows described above, there exist a number of modules that are used by these main workflows. They can also be run standalone, and are intendet to make composing the capabilities of our main workflows simpler. These are:
 
-- `verify-msrv.yaml` - checks if the MSRV ('Minimum Supported Rust Version) declared in Cargo.toml is correct
-- `coverage.yaml` - collects test code coverage, and can optionally upload the results to codecov.io
+- [`coverage.yaml`](coverage.yaml) - collects test code coverage, and can optionally upload the results to codecov.io
   - Will publish coverage data to CodeCov if `${{ secrets.CODECOV_TOKEN }}` is set
   - outputs: download URL for the workflow-generated coverage info file
-- `license-report.yaml` - create a license report for `up-rust` and all its dependencies in html format
+- [`license-report.yaml`](license-report.yaml) - create a license report for `up-rust` and all its dependencies in html format
   - outputs: download URL for the workflow-generated license report
-- `test-featurematrix.yaml` - Test all feature combinations on a range of OS platforms
-- `x-build.yaml` - Run release builds on multiple architecture targets
+- [`test-featurematrix.yaml`](test-featurematrix.yaml) - Test all feature combinations on a range of OS platforms
+- [`verify-msrv.yaml`](verify-msrv.yaml) - checks if the MSRV ('Minimum Supported Rust Version) declared in Cargo.toml is correct
+- [`x-build.yaml`](x-build.yaml) - Run release builds on multiple architecture targets

Dockerfile

@@ -0,0 +1,39 @@
+################################################################################
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+################################################################################
+
+FROM rust:slim as build
+
+# create a new empty shell project
+RUN USER=root mkdir /up-subscription-rust
+WORKDIR /up-subscription-rust
+
+# clone workspace
+COPY ./ ./
+# not yet available on stable syntax
+#COPY --exclude=target ./ ./
+
+# this build step will cache your dependencies, use same profile as cargo-dist
+RUN cargo build --all-features --profile=dist
+
+# our final base
+FROM debian:stable-slim
+
+# copy the build artifact from the build stage
+COPY --from=build /up-subscription-rust/target/dist/up-subscription-cli .
+RUN chmod +x /up-subscription-cli
+
+ADD tools/startup.sh /
+RUN chmod +x /startup.sh
+
+# set the startup command to run your binary
+ENTRYPOINT ["/startup.sh"]

docker-compose.yaml

@@ -0,0 +1,25 @@
+################################################################################
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+################################################################################
+
+services:
+  up-subscription:
+    container_name: up-subscription
+    image: up-subscription:latest
+    build:
+      context: .
+    network_mode: host
+    restart: unless-stopped
+    environment:
+      - AUTHORITY=usubscription.local
+      - TRANSPORT=zenoh
+      - VERBOSE=true

tools/startup.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+/up-subscription-cli

up-subscription-cli/Cargo.toml

@@ -35,7 +35,7 @@ zenoh = ["dep:up-transport-zenoh"]
 [dependencies]
 async-mutex = { workspace = true }
 async-trait = { workspace = true }
-clap = { version = "4.5", features = ["derive"] }
+clap = { version = "4.5", features = ["derive", "env"] }
 clap-num = { version = "1.1" }
 env_logger = { workspace = true }
 futures = { workspace = true }

up-subscription-cli/src/main.rs

@@ -72,7 +72,7 @@ enum Transports {
 #[command(version, about = "Rust implementation of Eclipse uProtocol USubscription service.", long_about = None)]
 pub(crate) struct Args {
     /// Authority name for usubscription service
-    #[arg(short, long)]
+    #[arg(short, long, env)]
     authority: String,
 
     /// Run as a daemon (in the background)
@@ -81,19 +81,19 @@ pub(crate) struct Args {
     daemon: bool,
 
     /// The transport implementation to use
-    #[arg(short, long)]
+    #[arg(short, long, env)]
     transport: Transports,
 
     /// Buffer size of subscription command channel - minimum 1, maximum 1024, defaults to 1024
-    #[arg(short, long, value_parser=between_1_and_1024)]
+    #[arg(short, long, env, value_parser=between_1_and_1024)]
     subscription_buffer: Option<usize>,
 
     /// Buffer size of notification command channel - minimum 1, maximum 1024, defaults to 1024
-    #[arg(short, long, value_parser=between_1_and_1024)]
+    #[arg(short, long, env, value_parser=between_1_and_1024)]
     notification_buffer: Option<usize>,
 
     /// Increase verbosity of output
-    #[arg(short, long, default_value_t = false)]
+    #[arg(short, long, env, default_value_t = false)]
     verbose: bool,
 }
 
@@ -155,17 +155,20 @@ async fn main() {
     );
 
     // Daemonize or wait for shutdown signal
-    if cfg!(unix) && args.daemon {
+    #[cfg(unix)]
+    if args.daemon {
         let daemonize = Daemonize::new();
         match daemonize.start() {
-            Ok(_) => debug!("Success, daemonized"),
+            Ok(_) => {
+                debug!("Success, running daemonized");
+            }
             Err(e) => error!("Error, {}", e),
         }
-    } else {
-        signal::ctrl_c().await.expect("failed to listen for event");
-        info!("Stopping usubscription service");
-        ustop.stop().await;
     }
+
+    signal::ctrl_c().await.expect("failed to listen for event");
+    info!("Stopping usubscription service");
+    ustop.stop().await;
 }
 
 fn config_from_args(args: &Args) -> Result<Arc<USubscriptionConfiguration>, ConfigurationError> {

up-subscription/Cargo.toml

@@ -36,3 +36,6 @@ uriparse = { version = "0.6" }
 [dev-dependencies]
 mockall = { workspace = true }
 test-case = { workspace = true }
+
+[package.metadata.dist]
+all-features = true