Skip to content

Commit

Permalink
refactor(rust): comment and add tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@etorreborre
etorreborre committed Nov 22, 2023
1 parent e3df53f commit 895eb12
Show file tree
Hide file tree
Showing 21 changed files with 687 additions and 409 deletions.
278 changes: 23 additions & 255 deletions implementations/rust/ockam/ockam_api/src/cli_state/enrollments.rs
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
use std::str::FromStr;
use std::sync::Arc;

use sqlx::sqlite::SqliteRow;
use sqlx::FromRow;
use sqlx::*;
use time::OffsetDateTime;

use ockam::identity::Identifier;
use ockam::{FromSqlxError, SqlxDatabase, ToSqlxType, ToVoid};
use ockam_core::async_trait;

use crate::cli_state::CliState;
use crate::cli_state::Result;
Expand All @@ -18,23 +10,25 @@ impl CliState {
let repository = self.enrollment_repository().await?;

match name {
Some(name) => repository.is_identity_enrolled(name).await,
None => repository.is_default_identity_enrolled().await,
Some(name) => Ok(repository.is_identity_enrolled(name).await?),
None => Ok(repository.is_default_identity_enrolled().await?),
}
}

pub async fn is_default_identity_enrolled(&self) -> Result<bool> {
self.enrollment_repository()
Ok(self
.enrollment_repository()
.await?
.is_default_identity_enrolled()
.await
.await?)
}

pub async fn set_identifier_as_enrolled(&self, identifier: &Identifier) -> Result<()> {
self.enrollment_repository()
Ok(self
.enrollment_repository()
.await?
.set_as_enrolled(identifier)
.await
.await?)
}

pub async fn set_node_as_enrolled(&self, node_name: &str) -> Result<()> {
Expand All @@ -48,136 +42,12 @@ impl CliState {
) -> Result<Vec<IdentityEnrollment>> {
let repository = self.enrollment_repository().await?;
match enrollment_status {
EnrollmentStatus::Enrolled => repository.get_enrolled_identities().await,
EnrollmentStatus::Any => repository.get_all_identities_enrollments().await,
EnrollmentStatus::Enrolled => Ok(repository.get_enrolled_identities().await?),
EnrollmentStatus::Any => Ok(repository.get_all_identities_enrollments().await?),
}
}
}

#[async_trait]
pub trait EnrollmentsRepository: Send + Sync + 'static {
async fn set_as_enrolled(&self, identifier: &Identifier) -> Result<()>;
async fn get_enrolled_identities(&self) -> Result<Vec<IdentityEnrollment>>;
async fn get_all_identities_enrollments(&self) -> Result<Vec<IdentityEnrollment>>;
async fn is_default_identity_enrolled(&self) -> Result<bool>;
async fn is_identity_enrolled(&self, name: &str) -> Result<bool>;
}

pub struct EnrollmentsSqlxDatabase {
database: Arc<SqlxDatabase>,
}

impl EnrollmentsSqlxDatabase {
pub fn new(database: Arc<SqlxDatabase>) -> Self {
debug!("create a repository for enrollments");
Self { database }
}

/// Create a new in-memory database
pub async fn create() -> Result<Arc<EnrollmentsSqlxDatabase>> {
Ok(Arc::new(Self::new(
SqlxDatabase::in_memory("enrollments").await?,
)))
}
}

#[async_trait]
impl EnrollmentsRepository for EnrollmentsSqlxDatabase {
async fn set_as_enrolled(&self, identifier: &Identifier) -> Result<()> {
let query = query("INSERT OR REPLACE INTO identity_enrollment VALUES (?, ?)")
.bind(identifier.to_sql())
.bind(OffsetDateTime::now_utc().to_sql());
Ok(query.execute(&self.database.pool).await.void()?)
}

async fn get_enrolled_identities(&self) -> Result<Vec<IdentityEnrollment>> {
let query = query_as(
r#"
SELECT
identity.identifier, named_identity.name, named_identity.is_default,
identity_enrollment.enrolled_at
FROM identity
INNER JOIN identity_enrollment ON
identity.identifier = identity_enrollment.identifier
INNER JOIN named_identity ON
identity.identifier = named_identity.identifier
"#,
)
.bind(None as Option<i64>);
let result: Vec<EnrollmentRow> = query.fetch_all(&self.database.pool).await.into_core()?;
result
.into_iter()
.map(|r| r.identity_enrollment())
.collect::<Result<Vec<_>>>()
}

async fn get_all_identities_enrollments(&self) -> Result<Vec<IdentityEnrollment>> {
let query = query_as(
r#"
SELECT
identity.identifier, named_identity.name, named_identity.is_default,
identity_enrollment.enrolled_at
FROM identity
LEFT JOIN identity_enrollment ON
identity.identifier = identity_enrollment.identifier
INNER JOIN named_identity ON
identity.identifier = named_identity.identifier
"#,
);
let result: Vec<EnrollmentRow> = query.fetch_all(&self.database.pool).await.into_core()?;
result
.into_iter()
.map(|r| r.identity_enrollment())
.collect::<Result<Vec<_>>>()
}

async fn is_default_identity_enrolled(&self) -> Result<bool> {
let query = query(
r#"
SELECT
identity_enrollment.enrolled_at
FROM identity
INNER JOIN identity_enrollment ON
identity.identifier = identity_enrollment.identifier
INNER JOIN named_identity ON
identity.identifier = named_identity.identifier
WHERE
named_identity.is_default = ?
"#,
)
.bind(true.to_sql());
let result: Option<SqliteRow> = query
.fetch_optional(&self.database.pool)
.await
.into_core()?;
Ok(result.map(|_| true).unwrap_or(false))
}

async fn is_identity_enrolled(&self, name: &str) -> Result<bool> {
let query = query(
r#"
SELECT
identity_enrollment.enrolled_at
FROM identity
INNER JOIN identity_enrollment ON
identity.identifier = identity_enrollment.identifier
INNER JOIN named_identity ON
identity.identifier = named_identity.identifier
INNER JOIN named_identity ON
identity.identifier = named_identity.identifier
WHERE
named_identity.name = ?
"#,
)
.bind(name.to_sql());
let result: Option<SqliteRow> = query
.fetch_optional(&self.database.pool)
.await
.into_core()?;
Ok(result.map(|_| true).unwrap_or(false))
}
}

pub enum EnrollmentStatus {
Enrolled,
Any,
Expand All @@ -191,6 +61,19 @@ pub struct IdentityEnrollment {
}

impl IdentityEnrollment {
pub fn new(
identifier: Identifier,
name: Option<String>,
is_default: bool,
enrolled_at: Option<OffsetDateTime>,
) -> Self {
Self {
identifier,
name,
is_default,
enrolled_at,
}
}
pub fn identifier(&self) -> Identifier {
self.identifier.clone()
}
Expand All @@ -215,118 +98,3 @@ impl IdentityEnrollment {
self.enrolled_at
}
}

#[derive(FromRow)]
pub struct EnrollmentRow {
identifier: String,
name: Option<String>,
is_default: bool,
enrolled_at: Option<i64>,
}

impl EnrollmentRow {
fn identity_enrollment(&self) -> Result<IdentityEnrollment> {
let identifier = Identifier::from_str(self.identifier.as_str())?;
Ok(IdentityEnrollment {
identifier,
name: self.name.clone(),
is_default: self.is_default,
enrolled_at: self.enrolled_at(),
})
}

fn enrolled_at(&self) -> Option<OffsetDateTime> {
self.enrolled_at
.map(|at| OffsetDateTime::from_unix_timestamp(at).unwrap_or(OffsetDateTime::now_utc()))
}
}

#[cfg(test)]
mod tests {
use std::path::Path;

use tempfile::NamedTempFile;

use ockam::identity::{ChangeHistoryRepository, ChangeHistorySqlxDatabase, Identity};

use crate::identity::{IdentitiesRepository, IdentitiesSqlxDatabase};

use super::*;

#[tokio::test]
async fn test_identities_enrollment_repository() -> Result<()> {
let db_file = NamedTempFile::new().unwrap();
let identity1 = create_identity1(db_file.path(), "identity1").await?;
create_identity2(db_file.path(), "identity2").await?;
let repository = create_repository(db_file.path()).await?;

// an identity can be enrolled
repository.set_as_enrolled(identity1.identifier()).await?;

// retrieve the identities and their enrollment status
let result = repository.get_all_identities_enrollments().await?;
assert_eq!(result.len(), 2);

// retrieve only the enrolled identities
let result = repository.get_enrolled_identities().await?;
assert_eq!(result.len(), 1);

// the first identity has been set as the default one
let result = repository.is_default_identity_enrolled().await?;
assert!(result);

Ok(())
}

/// HELPERS
async fn create_identity1(path: &Path, name: &str) -> Result<Identity> {
let identity = Identity::create(
"81a201583ba20101025835a4028201815820530d1c2e9822433b679a66a60b9c2ed47c370cd0ce51cbe1a7ad847b5835a96303f4041a64dd4060051a77a94360028201815840042fff8f6c80603fb1cec4a3cf1ff169ee36889d3ed76184fe1dfbd4b692b02892df9525c61c2f1286b829586d13d5abf7d18973141f734d71c1840520d40a0e",
)
.await?;
store_identity(path, name, identity).await
}

async fn create_identity2(path: &Path, name: &str) -> Result<Identity> {
let identity = Identity::create(
"81a201583ba20101025835a4028201815820afbca9cf5d440147450f9f0d0a038a337b3fe5c17086163f2c54509558b62ef403f4041a64dd404a051a77a9434a0282018158407754214545cda6e7ff49136f67c9c7973ec309ca4087360a9f844aac961f8afe3f579a72c0c9530f3ff210f02b7c5f56e96ce12ee256b01d7628519800723805",
)
.await?;
store_identity(path, name, identity).await
}

async fn store_identity(path: &Path, name: &str, identity: Identity) -> Result<Identity> {
let change_history_repository = create_change_history_repository(path).await?;
let identities_repository = create_identities_repository(path).await?;
change_history_repository
.store_change_history(&identity)
.await?;

identities_repository
.store_named_identity(identity.identifier(), name, "vault")
.await?;
if name == "identity1" {
identities_repository
.set_as_default_by_identifier(identity.identifier())
.await?;
}
Ok(identity)
}

async fn create_repository(path: &Path) -> Result<Arc<dyn EnrollmentsRepository>> {
let db = SqlxDatabase::create(path).await?;
Ok(Arc::new(EnrollmentsSqlxDatabase::new(Arc::new(db))))
}

async fn create_change_history_repository(
path: &Path,
) -> Result<Arc<dyn ChangeHistoryRepository>> {
let db = SqlxDatabase::create(path).await?;
Ok(Arc::new(ChangeHistorySqlxDatabase::new(Arc::new(db))))
}

async fn create_identities_repository(path: &Path) -> Result<Arc<dyn IdentitiesRepository>> {
let db = SqlxDatabase::create(path).await?;
Ok(Arc::new(IdentitiesSqlxDatabase::new(Arc::new(db))))
}
}
30 changes: 30 additions & 0 deletions implementations/rust/ockam/ockam_api/src/cli_state/enrollments_repository.rs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
use crate::cli_state::enrollments::IdentityEnrollment;
use ockam::identity::Identifier;
use ockam_core::async_trait;
use ockam_core::Result;

/// This trait stores the enrollment status for identities
/// If an identity has been enrolled it is possible to retrieve:
///
/// - its name (if it has one)
/// - if this the default identity
/// - if an identity was enrolled and when the local node was informed
///
///
#[async_trait]
pub trait EnrollmentsRepository: Send + Sync + 'static {
/// Set the identifier as enrolled, and set a timestamp to record the information
async fn set_as_enrolled(&self, identifier: &Identifier) -> Result<()>;

/// Get the list of enrolled identities
async fn get_enrolled_identities(&self) -> Result<Vec<IdentityEnrollment>>;

/// Get the enrollment statuses for all known identities
async fn get_all_identities_enrollments(&self) -> Result<Vec<IdentityEnrollment>>;

/// Return true if the default identity is enrolled
async fn is_default_identity_enrolled(&self) -> Result<bool>;

/// Return true if the identity with the given name is enrolled
async fn is_identity_enrolled(&self, name: &str) -> Result<bool>;
}
Loading

0 comments on commit 895eb12

Please sign in to comment.