From fb570e02d56b47a812e2a27b6b62eba01ce0416f Mon Sep 17 00:00:00 2001
From: Tony Arcieri <bascule@gmail.com>
Date: Sat, 22 Jan 2022 15:48:43 -0700
Subject: spake2: capitalization and doc fixes (#89)

Renames the following:

- `SPAKE2` => `Spake2`
- `SPAKEErr` -> `Error`

Additionally lints for `missing_docs` and adds preliminary documentation
for all types and methods which previously had none.
---
 spake2/tests/spake2.rs | 32 +++++++++++---------------------
 1 file changed, 11 insertions(+), 21 deletions(-)

(limited to 'spake2/tests/spake2.rs')

diff --git a/spake2/tests/spake2.rs b/spake2/tests/spake2.rs
index 07ba946..eeced91 100644
--- a/spake2/tests/spake2.rs
+++ b/spake2/tests/spake2.rs
@@ -1,13 +1,13 @@
-use spake2::{Ed25519Group, ErrorType, Identity, Password, SPAKEErr, SPAKE2};
+use spake2::{Ed25519Group, Error, Identity, Password, Spake2};
 
 #[test]
 fn test_basic() {
-    let (s1, msg1) = SPAKE2::<Ed25519Group>::start_a(
+    let (s1, msg1) = Spake2::<Ed25519Group>::start_a(
         &Password::new(b"password"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
     );
-    let (s2, msg2) = SPAKE2::<Ed25519Group>::start_b(
+    let (s2, msg2) = Spake2::<Ed25519Group>::start_b(
         &Password::new(b"password"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
@@ -19,12 +19,12 @@ fn test_basic() {
 
 #[test]
 fn test_mismatch() {
-    let (s1, msg1) = SPAKE2::<Ed25519Group>::start_a(
+    let (s1, msg1) = Spake2::<Ed25519Group>::start_a(
         &Password::new(b"password"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
     );
-    let (s2, msg2) = SPAKE2::<Ed25519Group>::start_b(
+    let (s2, msg2) = Spake2::<Ed25519Group>::start_b(
         &Password::new(b"password2"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
@@ -36,23 +36,18 @@ fn test_mismatch() {
 
 #[test]
 fn test_reflected_message() {
-    let (s1, msg1) = SPAKE2::<Ed25519Group>::start_a(
+    let (s1, msg1) = Spake2::<Ed25519Group>::start_a(
         &Password::new(b"password"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
     );
     let r = s1.finish(msg1.as_slice());
-    assert_eq!(
-        r.unwrap_err(),
-        SPAKEErr {
-            kind: ErrorType::BadSide,
-        }
-    );
+    assert_eq!(r.unwrap_err(), Error::BadSide);
 }
 
 #[test]
 fn test_bad_length() {
-    let (s1, msg1) = SPAKE2::<Ed25519Group>::start_a(
+    let (s1, msg1) = Spake2::<Ed25519Group>::start_a(
         &Password::new(b"password"),
         &Identity::new(b"idA"),
         &Identity::new(b"idB"),
@@ -60,21 +55,16 @@ fn test_bad_length() {
     let mut msg2 = Vec::<u8>::with_capacity(msg1.len() + 1);
     msg2.resize(msg1.len() + 1, 0u8);
     let r = s1.finish(&msg2);
-    assert_eq!(
-        r.unwrap_err(),
-        SPAKEErr {
-            kind: ErrorType::WrongLength,
-        }
-    );
+    assert_eq!(r.unwrap_err(), Error::WrongLength);
 }
 
 #[test]
 fn test_basic_symmetric() {
-    let (s1, msg1) = SPAKE2::<Ed25519Group>::start_symmetric(
+    let (s1, msg1) = Spake2::<Ed25519Group>::start_symmetric(
         &Password::new(b"password"),
         &Identity::new(b"idS"),
     );
-    let (s2, msg2) = SPAKE2::<Ed25519Group>::start_symmetric(
+    let (s2, msg2) = Spake2::<Ed25519Group>::start_symmetric(
         &Password::new(b"password"),
         &Identity::new(b"idS"),
     );
-- 
cgit v1.2.3