chore: Rename to famedly-sync

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "ldap-sync"
+name = "famedly-sync"
 version = "0.5.0"
 authors = []
 edition = "2021"

Dockerfile

@@ -22,8 +22,8 @@ RUN cargo auditable build --release
 
 FROM debian:bookworm-slim
 RUN apt update && apt install ca-certificates curl -y
-RUN mkdir -p /opt/famedly-sync-agent
-WORKDIR /opt/famedly-sync-agent
-COPY --from=builder /app/target/release/ldap-sync /usr/local/bin/famedly-sync-agent
-ENV FAMEDLY_LDAP_SYNC_CONFIG="/opt/famedly-sync-agent/config.yaml"
-ENTRYPOINT ["/usr/local/bin/famedly-sync-agent"]
+RUN mkdir -p /opt/famedly-sync
+WORKDIR /opt/famedly-sync
+COPY --from=builder /app/target/release/famedly-sync /usr/local/bin/famedly-sync
+ENV FAMEDLY_SYNC_CONFIG="/opt/famedly-sync/config.yaml"
+ENTRYPOINT ["/usr/local/bin/famedly-sync"]

README.md

@@ -11,7 +11,7 @@ Currently supported sources:
 
 The tool expects a configuration file located at `./config.yaml`. See example configuration at [config.sample.yaml](./config.sample.yaml).
 
-The default path can be changed by setting the new path to the environment variable `FAMEDLY_LDAP_SYNC_CONFIG`.
+The default path can be changed by setting the new path to the environment variable `FAMEDLY_SYNC_CONFIG`.
 
 Also, individual configuration items and the whole configuration can be set using environment variables. For example, the following YAML configuration:
 
@@ -24,10 +24,10 @@ sources:
 Could be set using the following environment variable:
 
 ```bash
-FAMEDLY_LDAP_SYNC__SOURCES__LDAP__URL="ldap://localhost:1389"
+FAMEDLY_SYNC__SOURCES__LDAP__URL="ldap://localhost:1389"
 ```
 
-Note that the environment variable name always starts with the prefix `FAMEDLY_LDAP_SYNC` followed by keys separated by double underscores (`__`).
+Note that the environment variable name always starts with the prefix `FAMEDLY_SYNC` followed by keys separated by double underscores (`__`).
 
 Some configuration items take a list of values. In this cases the values should be separated by space. **If an empty list is desired the variable shouldn't be created.**
 

src/config.rs

@@ -20,7 +20,7 @@ use crate::{
 };
 
 /// App prefix for env var configuration
-const ENV_VAR_CONFIG_PREFIX: &str = "FAMEDLY_LDAP_SYNC";
+const ENV_VAR_CONFIG_PREFIX: &str = "FAMEDLY_SYNC";
 /// Separator for setting a list using env vars
 const ENV_VAR_LIST_SEP: &str = " ";
 

src/main.rs

@@ -2,7 +2,7 @@
 use std::{path::Path, process::ExitCode, str::FromStr};
 
 use anyhow::{Context, Result};
-use ldap_sync::Config;
+use famedly_sync::Config;
 use tracing::level_filters::LevelFilter;
 
 #[tokio::main]
@@ -20,7 +20,7 @@ async fn main() -> ExitCode {
 #[allow(clippy::print_stderr)]
 async fn run_sync() -> Result<()> {
 	let config = {
-		let config_path = std::env::var("FAMEDLY_LDAP_SYNC_CONFIG").unwrap_or("config.yaml".into());
+		let config_path = std::env::var("FAMEDLY_SYNC_CONFIG").unwrap_or("config.yaml".into());
 		let config_path = Path::new(&config_path);
 		match Config::new(config_path) {
 			Ok(config) => config,

src/sources/csv.rs

@@ -26,7 +26,7 @@ impl Source for CsvSource {
 		let new_users = self.read_csv()?;
 		// TODO: Implement changed and deleted users
 		// Holding off on this until we get rid of the cache concept
-		// https://github.com/famedly/ldap-sync/issues/53
+		// https://github.com/famedly/famedly-sync/issues/53
 		return Ok(SourceDiff { new_users, changed_users: vec![], deleted_user_ids: vec![] });
 	}
 }

tests/e2e.rs

@@ -3,14 +3,14 @@
 use std::{collections::HashSet, path::Path, time::Duration};
 
 use base64::prelude::{Engine, BASE64_STANDARD};
-use ldap3::{Ldap as LdapClient, LdapConnAsync, LdapConnSettings, Mod};
-use ldap_sync::{
+use famedly_sync::{
 	csv_test_helpers::temp_csv_file,
 	ukt_test_helpers::{
 		get_mock_server_url, prepare_endpoint_mock, prepare_oauth2_mock, ENDPOINT_PATH, OAUTH2_PATH,
 	},
 	AttributeMapping, Config, FeatureFlag,
 };
+use ldap3::{Ldap as LdapClient, LdapConnAsync, LdapConnSettings, Mod};
 use tempfile::TempDir;
 use test_log::test;
 use tokio::sync::OnceCell;

tests/environment/docker-compose.yaml

@@ -17,7 +17,7 @@ services:
         read_only: true
 
   test-setup:
-    image: famedly/ldap-sync-testenv
+    image: famedly/famedly-sync-testenv
     build:
       context: ./test-setup
     entrypoint: /environment/test-setup.sh