Fix/default fix (#301)

* make the Party class default to a real value when the is no name given.

* clean up serialization

* Clean up constructor and fix an issue with C test

* fixed missing xml comments

Author: SteveMaier-IRT

bindings/netstandard/ElectionGuard/ElectionGuard.Encryption.Tests/TestManifest.cs

@@ -34,6 +34,16 @@ public void Test_Can_Construct_Internationalized_Text()
             Assert.That(actual.Value == "some words");
         }
 
+        [Test]
+        public void Test_Can_Party()
+        {
+            // Act
+            var party = new Party("new party");
+
+            // Assert
+            Assert.IsNotNull(party.Name);
+        }
+
         [Test]
         public void Test_Can_Construct_Ballot_style()
         {

bindings/netstandard/ElectionGuard/ElectionGuard.Encryption/Election.cs

@@ -220,6 +220,16 @@ public unsafe CiphertextElectionContext(ulong numberOfGuardians,
             status.ThrowIfError();
         }
 
+        /// <summary>
+        ///  Makes a CiphertextElectionContext object.
+        ///
+        /// <param name="numberOfGuardians"> The number of guardians necessary to generate the public key </param>
+        /// <param name="quorum"> The quorum of guardians necessary to decrypt an election.  Must be less than `number_of_guardians` </param>
+        /// <param name="publicKey"> the public key of the election </param>
+        /// <param name="commitmentHash"> the hash of the commitments the guardians make to each other </param>
+        /// <param name="manifestHash"> the hash of the election metadata </param>
+        /// <param name="config"> the context configuration</param>
+        /// </summary>
         public unsafe CiphertextElectionContext(ulong numberOfGuardians,
                 ulong quorum,
                 ElementModP publicKey,
@@ -258,7 +268,17 @@ public unsafe CiphertextElectionContext(ulong numberOfGuardians,
         }
 
 
-
+        /// <summary>
+        ///  Makes a CiphertextElectionContext object.
+        ///
+        /// <param name="numberOfGuardians"> The number of guardians necessary to generate the public key </param>
+        /// <param name="quorum"> The quorum of guardians necessary to decrypt an election.  Must be less than `number_of_guardians` </param>
+        /// <param name="publicKey"> the public key of the election </param>
+        /// <param name="commitmentHash"> the hash of the commitments the guardians make to each other </param>
+        /// <param name="manifestHash"> the hash of the election metadata </param>
+        /// <param name="config"> the context configuration</param>
+        /// <param name="extendedData"> an unordered map of key value strings revelant to the consuming application </param>
+        /// </summary>
         public unsafe CiphertextElectionContext(ulong numberOfGuardians,
                 ulong quorum,
                 ElementModP publicKey,

include/electionguard/manifest.hpp

@@ -438,6 +438,8 @@ namespace electionguard
         explicit Party(const std::string &objectId, std::unique_ptr<InternationalizedText> name,
                        const std::string &abbreviation, const std::string &color,
                        const std::string &logoUri);
+        explicit Party(const std::string &objectId, const std::string &abbreviation,
+                       const std::string &color, const std::string &logoUri);
         ~Party();
 
         Party &operator=(Party other);
@@ -1058,8 +1060,7 @@ namespace electionguard
         static std::vector<std::unique_ptr<GeopoliticalUnit>>
         copyGeopoliticalUnits(const Manifest &description);
 
-        static std::vector<std::unique_ptr<Candidate>>
-        copyCandidates(const Manifest &description);
+        static std::vector<std::unique_ptr<Candidate>> copyCandidates(const Manifest &description);
 
         static std::vector<std::unique_ptr<BallotStyle>>
         copyBallotStyles(const Manifest &description);

src/electionguard/manifest.cpp

@@ -700,19 +700,26 @@ namespace electionguard
         string color;
         string logoUri;
 
-        explicit Impl(const string &objectId) { this->object_id = objectId; }
+        void init(const string &objectId)
+        {
+            this->object_id = objectId;
+            vector<unique_ptr<Language>> text;
+            this->name = make_unique<InternationalizedText>(move(text));
+        }
+
+        explicit Impl(const string &objectId) { init(objectId); }
 
         explicit Impl(const string &objectId, const string &abbreviation)
             : abbreviation(abbreviation)
         {
-            this->object_id = objectId;
+            init(objectId);
         }
 
         explicit Impl(const string &objectId, const string &abbreviation, const string &color,
                       const string &logoUri)
             : abbreviation(abbreviation), color(color), logoUri(logoUri)
         {
-            this->object_id = objectId;
+            init(objectId);
         }
 
         explicit Impl(const string &objectId, unique_ptr<InternationalizedText> name,
@@ -764,6 +771,12 @@ namespace electionguard
     {
     }
 
+    Party::Party(const string &objectId, const string &abbreviation, const string &color,
+                 const string &logoUri)
+        : pimpl(new Impl(objectId, abbreviation, color, logoUri))
+    {
+    }
+
     Party::~Party() = default;
 
     Party &Party::operator=(Party other)
@@ -1508,7 +1521,7 @@ namespace electionguard
             if (name == nullptr) {
                 auto hash = hash_elems(
                   {electionScopeId, getElectionTypeString(type), timePointToIsoString(startDate),
-                   timePointToIsoString(endDate), nullptr, geopoliticalUnitRefs, partyRefs,
+                   timePointToIsoString(endDate), nullptr, nullptr, geopoliticalUnitRefs, partyRefs,
                    contestRefs, ballotStyleRefs});
                 Log::trace("Manifest:: NO NAME!", hash->toHex());
                 return hash;
@@ -1813,8 +1826,8 @@ namespace electionguard
              vector<unique_ptr<ContestDescriptionWithPlaceholders>> contests,
              vector<unique_ptr<BallotStyle>> ballotStyles, unique_ptr<ElementModQ> manifestHash)
             : geopoliticalUnits(move(geopoliticalUnits)), candidates(move(candidates)),
-              contests(move(contests)),
-              ballotStyles(move(ballotStyles)), manifestHash(move(manifestHash))
+              contests(move(contests)), ballotStyles(move(ballotStyles)),
+              manifestHash(move(manifestHash))
         {
         }
     };
@@ -1829,8 +1842,7 @@ namespace electionguard
       vector<unique_ptr<ContestDescriptionWithPlaceholders>> contests,
       vector<unique_ptr<BallotStyle>> ballotStyles, const ElementModQ &manifestHash)
         : pimpl(new Impl(move(geopoliticalUnits), move(candidates), move(contests),
-                         move(ballotStyles),
-                         make_unique<ElementModQ>(manifestHash)))
+                         move(ballotStyles), make_unique<ElementModQ>(manifestHash)))
     {
     }
 

src/electionguard/serialize.hpp

@@ -69,8 +69,10 @@ namespace electionguard
     static unique_ptr<InternationalizedText> internationalizedTextFromJson(const json &j)
     {
         vector<unique_ptr<Language>> text;
-        for (const auto &i : j["text"]) {
-            text.push_back(languageFromJson(i));
+        if (j.contains("text") && !j["text"].is_null()) {
+            for (const auto &i : j["text"]) {
+                text.push_back(languageFromJson(i));
+            }
         }
         return make_unique<InternationalizedText>(move(text));
     }
@@ -212,24 +214,24 @@ namespace electionguard
     static unique_ptr<Party> partyFromJson(const json &j)
     {
         // TODO: other cases
-        if (j.contains("name") && !j["name"].is_null()) {
-            string abbreviation;
-            string color;
-            string logo_uri;
-            if (!j["abbreviation"].is_null()) {
-                abbreviation = j["abbreviation"].get<string>();
-            }
-            if (!j["color"].is_null()) {
-                color = j["color"].get<string>();
-            }
-            if (!j["logo_uri"].is_null()) {
-                logo_uri = j["logo_uri"].get<string>();
-            }
-            return make_unique<Party>(j["object_id"].get<string>(),
-                                      internationalizedTextFromJson(j["name"]), abbreviation, color,
-                                      logo_uri);
+        string abbreviation;
+        string color;
+        string logo_uri;
+        if (j.contains("abbreviation") && !j["abbreviation"].is_null()) {
+            abbreviation = j["abbreviation"].get<string>();
         }
-        return make_unique<Party>(j["object_id"].get<string>());
+        if (j.contains("color") && !j["color"].is_null()) {
+            color = j["color"].get<string>();
+        }
+        if (j.contains("logo_uri") && !j["logo_uri"].is_null()) {
+            logo_uri = j["logo_uri"].get<string>();
+        }
+        auto name = j.contains("name") && !j["name"].is_null()
+                      ? internationalizedTextFromJson(j["name"])
+                      : internationalizedTextFromJson(json("{}"));
+
+        return make_unique<Party>(j["object_id"].get<string>(), move(name), abbreviation, color,
+                                  logo_uri);
     }
 
     static json partiesToJson(const vector<reference_wrapper<Party>> &serializable)
@@ -280,7 +282,7 @@ namespace electionguard
         auto objectId = j["object_id"].get<string>();
         auto name = j.contains("name") && !j["name"].is_null()
                       ? internationalizedTextFromJson(j["name"])
-                      : nullptr;
+                      : internationalizedTextFromJson("{}");
         bool isWriteIn = j.contains("is_write_in") && !j["is_write_in"].is_null()
                            ? j["is_write_in"].get<bool>()
                            : false;
@@ -289,8 +291,7 @@ namespace electionguard
         auto imageUri =
           j.contains("image_uri") && !j["image_uri"].is_null() ? j["image_uri"].get<string>() : "";
 
-        return make_unique<Candidate>(objectId, name != nullptr ? move(name) : nullptr, partyId,
-                                      imageUri, isWriteIn);
+        return make_unique<Candidate>(objectId, move(name), partyId, imageUri, isWriteIn);
     }
 
     static json candidatesToJson(const vector<reference_wrapper<Candidate>> &serializable)