Generalize election management commands by z-bowen · Pull Request #2515 · bigchaindb/bigchaindb

z-bowen · 2018-09-05T11:30:29Z

Problem: CLI methods for election management need to be generalized away from upsert-validator

Solution

Rework the CLI methods to work with the more general Election base class

…from a common `Election` class Solution: Factored the common logic out of `ValidatorElection` and moved it to `Election` parent class

Solution: Reverting the changes

Solution: Refactored `get_result_by_election_id` to `get_election_result_by_id`

…ables Solution: Remove `DB_TABLE` property from `Election` class

…ir own tables" This reverts commit db45374.

… for an election method Solution: Finished the refactoring

Solution: Created the `elections` table with secondary_index `election_id`

…tions in the `elections` table Solution: Updated the class to use the new table

Solution: Renamed, refactored and moved the `Vote` class to tie in with the more general `Election` base class

Solution: Fixed the docstring

Solution: Pointed the reference to the class variable

…ote` Solution: Renamed `TX_SCHEMA_VALIDATOR_ELECTION_VOTE` as `TX_SCHEMA_VOTE`

Solution: Renamed `ELECTION_TYPE` to `OPERATION`

…ement-commands

…ed to manage any type of election Solution: Refactored the CLI to manage generalized elections

codecov-io · 2018-09-05T11:37:47Z

Codecov Report

Merging #2515 into master will decrease coverage by 0.01%.
The diff coverage is 93.75%.

@@            Coverage Diff             @@
##           master    #2515      +/-   ##
==========================================
- Coverage   93.37%   93.36%   -0.02%     
==========================================
  Files          43       44       +1     
  Lines        2583     2594      +11     
==========================================
+ Hits         2412     2422      +10     
- Misses        171      172       +1

…lass Solution: Create a default method that work if all fields in the 'asset[data]' can be displayed without additional formatting

Solution: Addressed comments from PR

…ement-commands

Solution: Removed the variable and hardcoded everything to use the `Vote` class

Solution: Addressing comments

…_class

…ement-commands

Solution: Aligned the tests to reflect the changed key format

ldmberman · 2018-09-10T15:23:26Z

bigchaindb/commands/bigchaindb.py

-                                                         help='Calls a new election.')
+    # parser for managing elections
+    election_parser = subparsers.add_parser('election',
+                                            help='Add/update/delete a validator.')


The help message needs an update.

Solution: Cast any public key to base64

Solution: Updated the help message

kansi · 2018-09-12T09:03:29Z

docs/server/source/server-reference/bigchaindb-cli.md

+
+###### election new upsert-validator
+
+Call an election to add/update/remove a validator from the validator set.


~~Call~~ Create/Generate

kansi · 2018-09-12T09:05:03Z

docs/server/source/server-reference/bigchaindb-cli.md

-#### upsert-validator approve
+#### election approve
+
+Approve an election by voting for it. The propsal generated by executing `bigchaindb election new ...` can approved by the validators using this command. The validator who is approving the proposal will spend all their votes i.e. if the validator has a network power of `10` then they will cast `10` votes for the proposal.


can approved by ... -> can be approved by ...

Solution: Fixed the typos

bigchaindb/commands/bigchaindb.py

ldmberman · 2018-09-12T10:00:16Z

bigchaindb/commands/bigchaindb.py

+    # Parser factory for each type of new election, so we get a bunch of commands that look like this:
+    # election new <some_election_type> <args>...
+    for name, data in elections.items():
+        help = data['help']


help is a reserved keyword - I would just .add_parser(name, data['help']).

Solution: Removed the variable, as we didn't really need it anyway

kansi · 2018-09-12T10:23:32Z

docs/server/source/server-reference/bigchaindb-cli.md

+## bigchaindb election

-Manage elections to add, update, or remove a validator from the validators set. The upsert-validator subcommands implement [BEP-21](https://github.com/bigchaindb/BEPs/tree/master/21), please refer it for more details.
+Manage elections to manage the BigChainDB network. The specifics of the election process are defined in [BEP-21](https://github.com/bigchaindb/BEPs/tree/master/21), please refer it for more details.


The specific for general election are described in BEP-18 and not BEP-21

Solution: Pointed them to BEP-18 instead of BEP-21

z-bowen added 18 commits August 31, 2018 10:31

Merge branch 'master' into abstract_election_class

7de4226

Problem: ValidatorElection and MigrationElection need to inherit …

3d67565

…from a common `Election` class Solution: Factored the common logic out of `ValidatorElection` and moved it to `Election` parent class

Problem: Adding base58 as a requirement seems to break the build...

4a631ef

Solution: Reverting the changes

Problem: Responding to a suggestion for improved method naming

560a815

Solution: Refactored `get_result_by_election_id` to `get_election_result_by_id`

Problem: No need to store different types of elections in their own t…

db45374

…ables Solution: Remove `DB_TABLE` property from `Election` class

Revert "Problem: No need to store different types of elections in the…

bd76b31

…ir own tables" This reverts commit db45374.

Problem: Missed a method in Bigchain class when updating the naming…

b468504

… for an election method Solution: Finished the refactoring

Problem: Need a table to store data for all elections

e7dae7d

Solution: Created the `elections` table with secondary_index `election_id`

Merge branch 'master' into abstract_election_class

fe8eb84

Problem: Election class needs to be updated to store concluded elec…

84a7cf7

…tions in the `elections` table Solution: Updated the class to use the new table

Problem: UpsertValidatorVote can be generalized to just be Vote

1e3caf8

Solution: Renamed, refactored and moved the `Vote` class to tie in with the more general `Election` base class

Problem: Error in docstring return signature

30a5b93

Solution: Fixed the docstring

Problem: Hardcoded reference to the VOTE_TYPE in Election base class

7d756bf

Solution: Pointed the reference to the class variable

Problem: Schema still refers to ValidatorElectionVote instead of `V…

331b52c

…ote` Solution: Renamed `TX_SCHEMA_VALIDATOR_ELECTION_VOTE` as `TX_SCHEMA_VOTE`

Problem: Election class variable ELECTION_TYPE is overly specific

0c64fbf

Solution: Renamed `ELECTION_TYPE` to `OPERATION`

Merge branch 'master' into abstract_election_class

b6a5150

Merge branch 'abstract_election_class' into generalize-election-manag…

abc7457

…ement-commands

Problem: Command line options for upsert-validator can be generaliz…

5cde9c8

…ed to manage any type of election Solution: Refactored the CLI to manage generalized elections

z-bowen requested review from kansi and ldmberman September 5, 2018 11:30

z-bowen added 8 commits September 5, 2018 14:10

Problem: Default for show_election not implemented for Election c…

b1c9d7d

…lass Solution: Create a default method that work if all fields in the 'asset[data]' can be displayed without additional formatting

Problem: Multiple small issues with style etc.

fdacca7

Solution: Addressed comments from PR

Merge branch 'abstract_election_class' into generalize-election-manag…

35bd61c

…ement-commands

Problem: Election class variable to VOTE_TYPE unnecessary

2eb32d9

Solution: Removed the variable and hardcoded everything to use the `Vote` class

Problem: Minor style issues with PR

38fcd4d

Solution: Addressing comments

Merge remote-tracking branch 'upstream/master' into abstract_election…

eae7182

…_class

Merge branch 'abstract_election_class' into generalize-election-manag…

a6f6b81

…ement-commands

Problem: Changes to format for validator keys broke some tests

d5a0c87

Solution: Aligned the tests to reflect the changed key format

ldmberman reviewed Sep 10, 2018

View reviewed changes

z-bowen added 3 commits September 12, 2018 10:37

Merge branch 'master' into generalize-election-management-commands

faff4d6

Problem: election show command displaying the base56 public key

28032b8

Solution: Cast any public key to base64

Problem: election_parser help message still refers to upsert-validator

12dd7ab

Solution: Updated the help message

kansi reviewed Sep 12, 2018

View reviewed changes

Problem: Some typos in the docs for election management

7333d48

Solution: Fixed the typos

kansi reviewed Sep 12, 2018

View reviewed changes

bigchaindb/commands/bigchaindb.py Show resolved Hide resolved

ldmberman reviewed Sep 12, 2018

View reviewed changes

bigchaindb/commands/bigchaindb.py Show resolved Hide resolved

ldmberman reviewed Sep 12, 2018

View reviewed changes

ldmberman approved these changes Sep 12, 2018

View reviewed changes

Problem: Variable help shadows a built in

71b71fd

Solution: Removed the variable, as we didn't really need it anyway

kansi reviewed Sep 12, 2018

View reviewed changes

Problem: Docs point to the wrong BEP for election specs

bd0b3c7

Solution: Pointed them to BEP-18 instead of BEP-21

kansi approved these changes Sep 12, 2018

View reviewed changes

kansi merged commit 8a7650c into bigchaindb:master Sep 12, 2018

ldmberman mentioned this pull request Sep 12, 2018

Extend bigchaindb election status for migration elections #2469

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generalize election management commands#2515

Generalize election management commands#2515
kansi merged 32 commits intobigchaindb:masterfrom
z-bowen:generalize-election-management-commands

z-bowen commented Sep 5, 2018

Uh oh!

codecov-io commented Sep 5, 2018 •

edited

Loading

Uh oh!

ldmberman Sep 10, 2018

Uh oh!

kansi Sep 12, 2018

Uh oh!

z-bowen Sep 12, 2018

Uh oh!

kansi Sep 12, 2018

Uh oh!

z-bowen Sep 12, 2018

Uh oh!

Uh oh!

Uh oh!

ldmberman Sep 12, 2018

Uh oh!

z-bowen Sep 12, 2018

Uh oh!

kansi Sep 12, 2018

Uh oh!

z-bowen Sep 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		###### election new upsert-validator

		Call an election to add/update/remove a validator from the validator set.

Conversation

z-bowen commented Sep 5, 2018

Solution

Uh oh!

codecov-io commented Sep 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-io commented Sep 5, 2018 •

edited

Loading