Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand unit test coverage in bitset.rs, iota_did.rs, and iota_document.rs #265

Merged
merged 3 commits into from
May 12, 2021
Merged

Expand unit test coverage in bitset.rs, iota_did.rs, and iota_document.rs #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2968d95
Add some tests
m-renaud Apr 29, 2021
97c8100
Add IotaDocument::try_from_core() unit tests
m-renaud May 12, 2021
c1c7f35
Fix clippy error
m-renaud May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion identity-core/src/common/bitset.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::utils::decode_b64;
use crate::utils::encode_b64;

/// A general-purpose compressed bitset.
#[derive(Clone, Debug)]
#[derive(Clone, Debug, PartialEq)]
pub struct BitSet(RoaringBitmap);

impl BitSet {
Expand Down Expand Up @@ -179,4 +179,32 @@ mod tests {

assert_eq!(set.len(), 0);
}

// Validate that a `deserialize_b64` ∘ `serialize_b64` round-trip results in the original bitset.
#[test]
fn test_serialize_b64_round_trip() {
let mut set = BitSet::new();
for index in 0..10 {
assert!(set.insert(index));
}

assert_eq!(
BitSet::deserialize_b64(set.serialize_b64().unwrap().as_str()).unwrap(),
set
);
}

// Validate that a `deserialize_slice` ∘ `serialize_vec` round-trip results in the original bitset.
#[test]
fn test_serialize_slice_round_trip() {
let mut set = BitSet::new();
for index in 0..10 {
assert!(set.insert(index));
}

assert_eq!(
BitSet::deserialize_slice(set.serialize_vec().unwrap().as_slice()).unwrap(),
set
);
}
}
4 changes: 2 additions & 2 deletions identity-core/src/common/one_or_many.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ use core::mem::replace;
use core::ops::Deref;
use core::slice::from_ref;

/// A generic container that stores one or many values of a given type.
/// A generic container that stores exactly one or many (0+) values of a given type.
#[derive(Clone, Hash, PartialEq, Eq, PartialOrd, Ord, Deserialize, Serialize)]
#[serde(untagged)]
pub enum OneOrMany<T> {
/// A single instance of `T`.
One(T),
/// Multiple instances of `T`.
/// Multiple (zero or more) instances of `T`.
Many(Vec<T>),
}

Expand Down
174 changes: 170 additions & 4 deletions identity-iota/src/did/doc/iota_document.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,17 +624,25 @@ mod tests {
use identity_did::document::CoreDocument;
use identity_did::service::Service;
use identity_did::verification::MethodData;
use identity_did::verification::MethodRef;
use identity_did::verification::MethodType;
use identity_did::verification::VerificationMethod;
use std::collections::BTreeMap;

const DID_ID: &str = "did:iota:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M";
const DID_AUTH: &str = "did:iota:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M#authentication";

fn controller() -> DID {
fn valid_did() -> DID {
DID_ID.parse().unwrap()
}

fn valid_properties() -> BTreeMap<String, Value> {
let mut properties: BTreeMap<String, Value> = BTreeMap::default();
properties.insert("created".to_string(), "2020-01-02T00:00:00Z".into());
properties.insert("updated".to_string(), "2020-01-02T00:00:00Z".into());
properties
}

fn core_verification_method(controller: &DID, fragment: &str) -> VerificationMethod {
VerificationMethod::builder(Default::default())
.id(controller.join(fragment).unwrap())
Expand Down Expand Up @@ -708,6 +716,164 @@ mod tests {
);
}

#[test]
fn test_invalid_try_from_core_invalid_id() {
let invalid_did: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
// INVALID
.id(invalid_did)
.authentication(core_verification_method(&valid_did(), "#auth-key"))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_no_created_field() {
let mut properties: BTreeMap<String, Value> = BTreeMap::default();
properties.insert("updated".to_string(), "2020-01-02T00:00:00Z".into());
// INVALID - missing "created" field.

let doc = IotaDocument::try_from_core(
CoreDocument::builder(properties)
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_no_updated_field() {
let mut properties: BTreeMap<String, Value> = BTreeMap::default();
properties.insert("created".to_string(), "2020-01-02T00:00:00Z".into());
// INVALID - missing "updated" field.

let doc = IotaDocument::try_from_core(
CoreDocument::builder(properties)
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_controller() {
let invalid_controller: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
// INVALID
.authentication(core_verification_method(&invalid_controller, "#auth-key"))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_authentication_method_ref() {
let invalid_ref: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
// INVALID
.authentication(MethodRef::Refer(invalid_ref))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_assertion_method_ref() {
let invalid_ref: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
// INVALID
.assertion_method(MethodRef::Refer(invalid_ref))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_key_agreement_ref() {
let invalid_ref: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
// INVALID
.key_agreement(MethodRef::Refer(invalid_ref))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_capability_delegation_ref() {
let invalid_ref: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
// INVALID
.capability_delegation(MethodRef::Refer(invalid_ref))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_invalid_try_from_core_invalid_capability_invocation_ref() {
let invalid_ref: DID = "did:invalid:HGE4tecHWL2YiZv5qAGtH7gaeQcaz2Z1CR15GWmMjY1M"
.parse()
.unwrap();
let doc = IotaDocument::try_from_core(
CoreDocument::builder(valid_properties())
.id(valid_did())
.authentication(core_verification_method(&valid_did(), "#auth-key"))
// INVALID
.capability_invocation(MethodRef::Refer(invalid_ref))
.build()
.unwrap(),
);

assert!(doc.is_err());
}

#[test]
fn test_new() {
//from keypair
Expand All @@ -734,7 +900,7 @@ mod tests {

#[test]
fn test_controller_from_core() {
let controller: DID = controller();
let controller: DID = valid_did();
let document: IotaDocument = iota_document_from_core(&controller);
let expected_controller: Option<IotaDID> = Some(IotaDID::try_from_owned(controller).unwrap());
assert_eq!(document.controller(), expected_controller.as_ref());
Expand All @@ -754,7 +920,7 @@ mod tests {
.parse()
.unwrap(),
)
.controller(controller())
.controller(valid_did())
.key_type(MethodType::Ed25519VerificationKey2018)
.key_data(MethodData::PublicKeyBase58(
"FJsXMk9UqpJf3ZTKnfEQAhvBrVLKMSx9ZeYwQME6c6tT".into(),
Expand All @@ -772,7 +938,7 @@ mod tests {

#[test]
fn test_methods_from_core() {
let controller: DID = controller();
let controller: DID = valid_did();
let document: IotaDocument = iota_document_from_core(&controller);
let expected: Vec<IotaVerificationMethod> = vec![
iota_verification_method(&controller, "#key-1"),
Expand Down
36 changes: 35 additions & 1 deletion identity-iota/src/did/url/iota_did.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,26 +306,57 @@ mod tests {
#[test]
fn test_parse_valid() {
assert!(IotaDID::parse(format!("did:iota:{}", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:{}#fragment", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:{}?somequery=somevalue", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:{}?somequery=somevalue#fragment", TAG)).is_ok());

assert!(IotaDID::parse(format!("did:iota:main:{}", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:main:{}#fragment", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:main:{}?somequery=somevalue", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:main:{}?somequery=somevalue#fragment", TAG)).is_ok());

assert!(IotaDID::parse(format!("did:iota:test:{}", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:test:{}#fragment", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:test:{}?somequery=somevalue", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:test:{}?somequery=somevalue#fragment", TAG)).is_ok());

assert!(IotaDID::parse(format!("did:iota:rainbow:{}", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:{}#fragment", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:{}?somequery=somevalue", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:{}?somequery=somevalue#fragment", TAG)).is_ok());

assert!(IotaDID::parse(format!("did:iota:rainbow:shard-1:{}", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:shard-1:{}#fragment", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:shard-1:{}?somequery=somevalue", TAG)).is_ok());
assert!(IotaDID::parse(format!("did:iota:rainbow:shard-1:{}?somequery=somevalue#fragment", TAG)).is_ok());
}

#[test]
fn test_parse_invalid() {
// A non-"iota" DID method is invalid.
assert!(IotaDID::parse("did:foo::").is_err());
// An empty DID method is invalid.
assert!(IotaDID::parse("did:::").is_err());
assert!(IotaDID::parse(format!("did::rainbow:shard-1:{}", TAG)).is_err());
// A non-"iota" DID method is invalid.
assert!(IotaDID::parse("did:iota---::").is_err());
// An empty `iota-specific-idstring` is invalid.
assert!(IotaDID::parse("did:iota:").is_err());
// Too many components is invalid.
assert!(IotaDID::parse(format!("did:iota:rainbow:shard-1:random:{}", TAG)).is_err());
}

#[test]
fn test_from_did() {
let key: String = IotaDID::encode_key(b"123");

let did: CoreDID = format!("did:iota:{}", key).parse().unwrap();
assert!(IotaDID::try_from_owned(did).is_ok());
let iota_did = IotaDID::try_from_owned(did).unwrap();
assert_eq!(iota_did.network(), "main");
assert_eq!(iota_did.shard(), None);
assert_eq!(iota_did.tag(), key);
assert_eq!(iota_did.path(), "");
assert_eq!(iota_did.query(), None);

let did: CoreDID = "did:iota:123".parse().unwrap();
assert!(IotaDID::try_from_owned(did).is_err());
Expand All @@ -352,6 +383,9 @@ mod tests {
fn test_shard() {
let key: String = IotaDID::encode_key(b"123");

let did: IotaDID = format!("did:iota:{}", key).parse().unwrap();
assert_eq!(did.shard(), None);

let did: IotaDID = format!("did:iota:dev:{}", key).parse().unwrap();
assert_eq!(did.shard(), None);

Expand Down