♻️ Migrate Election Builder (Election-Tech-Initiative#674)

* ♻️ Migrate Election Builder

* ♻️ Remove TODO to migrate

Co-authored-by: Lee Richardson <[email protected]>

Author: keithrfung

src/electionguard/__init__.py

@@ -18,7 +18,6 @@
 from electionguard import decryption_share
 from electionguard import discrete_log
 from electionguard import election
-from electionguard import election_builder
 from electionguard import election_object_base
 from electionguard import election_polynomial
 from electionguard import elgamal
@@ -189,9 +188,6 @@
     Configuration,
     make_ciphertext_election_context,
 )
-from electionguard.election_builder import (
-    ElectionBuilder,
-)
 from electionguard.election_object_base import (
     ElectionObjectBase,
     OrderedObjectBase,
@@ -468,7 +464,6 @@
     "ElGamalKeyPair",
     "ElGamalPublicKey",
     "ElGamalSecretKey",
-    "ElectionBuilder",
     "ElectionConstants",
     "ElectionGuardLog",
     "ElectionJointKey",
@@ -609,7 +604,6 @@
     "div_p",
     "div_q",
     "election",
-    "election_builder",
     "election_object_base",
     "election_polynomial",
     "elgamal",

src/electionguard_cli/cli_steps/election_builder_step.py

@@ -2,8 +2,8 @@
 import click
 from electionguard.elgamal import ElGamalPublicKey
 from electionguard.group import ElementModQ
-from electionguard.election_builder import ElectionBuilder
 from electionguard.utils import get_optional
+from electionguard_tools.helpers.election_builder import ElectionBuilder
 
 from ..cli_models import CliElectionInputsBase, BuildElectionResults
 from .cli_step_base import CliStepBase

src/electionguard_tools/__init__.py

@@ -29,6 +29,7 @@
     DEVICE_PREFIX,
     ELECTION_RECORD_DIR,
     ENCRYPTED_TALLY_FILE_NAME,
+    ElectionBuilder,
     GUARDIANS_DIR,
     GUARDIAN_PREFIX,
     KeyCeremonyOrchestrator,
@@ -43,6 +44,7 @@
     TALLY_FILE_NAME,
     TallyCeremonyOrchestrator,
     accumulate_plaintext_ballots,
+    election_builder,
     export,
     export_private_data,
     export_record,
@@ -116,6 +118,7 @@
     "DEVICE_PREFIX",
     "ELECTION_RECORD_DIR",
     "ENCRYPTED_TALLY_FILE_NAME",
+    "ElectionBuilder",
     "ElectionFactory",
     "ElectionSampleDataGenerator",
     "ElectionsAndBallotsTupleType",
@@ -146,6 +149,7 @@
     "contest_descriptions",
     "contest_descriptions_room_for_overvoting",
     "election",
+    "election_builder",
     "election_descriptions",
     "election_factory",
     "election_types",

src/electionguard_tools/factories/election_factory.py

@@ -17,7 +17,6 @@
 from electionguard.ballot import PlaintextBallot
 from electionguard.constants import ElectionConstants, get_constants
 from electionguard.election import CiphertextElectionContext
-from electionguard.election_builder import ElectionBuilder
 from electionguard.elgamal import ElGamalPublicKey
 from electionguard.encrypt import EncryptionDevice, contest_from, generate_device_uuid
 from electionguard.group import TWO_MOD_Q
@@ -48,6 +47,7 @@
 from electionguard_tools.helpers.key_ceremony_orchestrator import (
     KeyCeremonyOrchestrator,
 )
+from electionguard_tools.helpers.election_builder import ElectionBuilder
 
 
 _T = TypeVar("_T")

src/electionguard_tools/helpers/__init__.py

@@ -1,8 +1,12 @@
+from electionguard_tools.helpers import election_builder
 from electionguard_tools.helpers import export
 from electionguard_tools.helpers import key_ceremony_orchestrator
 from electionguard_tools.helpers import tally_accumulate
 from electionguard_tools.helpers import tally_ceremony_orchestrator
 
+from electionguard_tools.helpers.election_builder import (
+    ElectionBuilder,
+)
 from electionguard_tools.helpers.export import (
     CIPHERTEXT_BALLOT_PREFIX,
     COEFFICIENTS_FILE_NAME,
@@ -45,6 +49,7 @@
     "DEVICE_PREFIX",
     "ELECTION_RECORD_DIR",
     "ENCRYPTED_TALLY_FILE_NAME",
+    "ElectionBuilder",
     "GUARDIANS_DIR",
     "GUARDIAN_PREFIX",
     "KeyCeremonyOrchestrator",
@@ -59,6 +64,7 @@
     "TALLY_FILE_NAME",
     "TallyCeremonyOrchestrator",
     "accumulate_plaintext_ballots",
+    "election_builder",
     "export",
     "export_private_data",
     "export_record",

src/electionguard/election_builder.py renamed to src/electionguard_tools/helpers/election_builder.py

@@ -5,18 +5,20 @@
 
 from electionguard.elgamal import ElGamalPublicKey
 
-from .election import CiphertextElectionContext, make_ciphertext_election_context
-from .group import ElementModQ
-from .manifest import Manifest, InternalManifest
-from .utils import get_optional
+from electionguard.election import (
+    CiphertextElectionContext,
+    make_ciphertext_election_context,
+)
+from electionguard.group import ElementModQ
+from electionguard.manifest import Manifest, InternalManifest
+from electionguard.utils import get_optional
 
 
 @dataclass
 class ElectionBuilder:
     """
     `ElectionBuilder` is a stateful builder object that constructs `CiphertextElectionContext` objects
     following the initialization process that ElectionGuard Expects.
-    SUGGESTION Perhaps move to test package.
     """
 
     number_of_guardians: int

tests/integration/test_end_to_end_election.py

@@ -14,7 +14,6 @@
 # Step 0 - Configure Election
 from electionguard.constants import ElectionConstants, get_constants
 from electionguard.election import CiphertextElectionContext
-from electionguard.election_builder import ElectionBuilder
 from electionguard.manifest import Manifest, InternalManifest
 
 # Step 1 - Key Ceremony
@@ -73,6 +72,8 @@
     ElectionFactory,
     NUMBER_OF_GUARDIANS,
 )
+from electionguard_tools.helpers.election_builder import ElectionBuilder
+
 
 devices_directory = path.join(ELECTION_RECORD_DIR, DEVICES_DIR)
 guardians_directory = path.join(ELECTION_RECORD_DIR, GUARDIANS_DIR)

tests/property/test_decryption_mediator.py

@@ -14,7 +14,6 @@
 from electionguard.data_store import DataStore
 from electionguard.decryption_mediator import DecryptionMediator
 from electionguard.election import CiphertextElectionContext
-from electionguard.election_builder import ElectionBuilder
 from electionguard.encrypt import (
     EncryptionMediator,
     encrypt_ballot,
@@ -44,6 +43,8 @@
     KeyCeremonyOrchestrator,
 )
 from electionguard_tools.helpers.tally_accumulate import accumulate_plaintext_ballots
+from electionguard_tools.helpers.election_builder import ElectionBuilder
+
 
 election_factory = ElectionFactory.ElectionFactory()
 ballot_factory = BallotFactory.BallotFactory()

tests/property/test_verify.py

@@ -11,7 +11,6 @@
 from electionguard.decryption import compute_decryption_share
 from electionguard.decryption_share import DecryptionShare
 from electionguard.decrypt_with_shares import decrypt_tally
-from electionguard.election_builder import ElectionBuilder
 from electionguard.elgamal import ElGamalKeyPair
 from electionguard.encrypt import EncryptionMediator, encrypt_ballot
 from electionguard.key_ceremony import CeremonyDetails
@@ -36,6 +35,8 @@
 from electionguard_tools.helpers.key_ceremony_orchestrator import (
     KeyCeremonyOrchestrator,
 )
+from electionguard_tools.helpers.election_builder import ElectionBuilder
+
 
 election_factory = ElectionFactory.ElectionFactory()
 ballot_factory = BallotFactory.BallotFactory()

tests/unit/test_decrypt_with_shares.py

@@ -20,7 +20,6 @@
     reconstruct_decryption_share_for_ballot,
 )
 from electionguard.decryption_share import DecryptionShare
-from electionguard.election_builder import ElectionBuilder
 from electionguard.encrypt import EncryptionMediator
 from electionguard.group import ElementModP
 from electionguard.guardian import Guardian
@@ -36,6 +35,8 @@
     KeyCeremonyOrchestrator,
 )
 from electionguard_tools.helpers.tally_accumulate import accumulate_plaintext_ballots
+from electionguard_tools.helpers.election_builder import ElectionBuilder
+
 
 election_factory = ElectionFactory.ElectionFactory()
 ballot_factory = BallotFactory.BallotFactory()

tests/unit/test_decryption.py

@@ -31,7 +31,6 @@
     mult_p,
     pow_p,
 )
-from electionguard.election_builder import ElectionBuilder
 from electionguard.encrypt import EncryptionMediator
 from electionguard.guardian import Guardian
 from electionguard.key_ceremony import (
@@ -49,6 +48,8 @@
     KeyCeremonyOrchestrator,
 )
 from electionguard_tools.helpers.tally_accumulate import accumulate_plaintext_ballots
+from electionguard_tools.helpers.election_builder import ElectionBuilder
+
 
 election_factory = ElectionFactory.ElectionFactory()
 ballot_factory = BallotFactory.BallotFactory()