Input verification #48

vteague · 2024-03-24T04:58:36Z

Implements classes for GenerateAssertionsRequest and GetAssertionsRequest
Implements Contest, with database retrieval and tests
Validates GenerateAssertionsRequests and GetAssertionsRequests, based on database retrieval, with tests.
Implements various other utils such as checking that a contest is all IRV.
Logs all exceptions.

Completes #38 and #34.
Partially completes #39.

…les, even though they are not quite set up right, and a trivial test of correct setup (which does not currently pass).

… contests by name.

michelleblom

Comments/requests for changes are all around commenting.

Added note: for Contest entity, should attributes be private with appropriate getters added?

We will need to remember to remove the TODO's/any code that will become redundant (if any) when we make requests based on contest name.

Tests seem very thorough!

src/main/java/au/org/democracydevelopers/raireservice/RaireJavaApplication.java

michelleblom · 2024-03-24T22:30:10Z

src/main/java/au/org/democracydevelopers/raireservice/persistence/entity/Contest.java

+  public long countyID;
+
+  /**
+   * Version. Currently not used.


This will be used for optimistic locking. Consider adding comment "Version, for optimistic locking."

Should it also be nullable=false and updatable=false?

Also note, for county_id attribute, comment refers to "this Assertion".

Also, should all attributes be nullable=false and updatable=false?

Agree that in Contest all attributes other than version should be nullable=false and updatable=false, which I've now done.

Need to think more about versions for Contest. We certainly won't update it, but perhaps someone else (i.e. colorado-rla) might, so I'm not sure what the updatable=false annotation implies about that case.

Actually on that point, if name is updated by canonicalization, is that consistent with the updatable=false annotation?

...n/java/au/org/democracydevelopers/raireservice/persistence/repository/ContestRepository.java

...est/java/au/org/democracydevelopers/raireservice/request/GenerateAssertionsRequestTests.java

src/test/java/au/org/democracydevelopers/raireservice/request/GetAssertionsRequestTests.java

….java

vteague · 2024-03-27T06:56:46Z

Thanks for that really careful review - I've marked as 'resolved' all the things I've just immediately changed. See above discussion for the slightly more complicated ones.

…ssertionsRequest.java into an abstract superclass called ContestRequest.java

Refactored common elements of GenerateAssertionsRequest.java and GetA…

src/main/java/au/org/democracydevelopers/raireservice/persistence/entity/Contest.java

...n/java/au/org/democracydevelopers/raireservice/persistence/repository/ContestRepository.java

michelleblom · 2024-03-27T23:47:20Z

src/main/java/au/org/democracydevelopers/raireservice/request/GetAssertionsRequest.java

+import java.math.BigDecimal;
+import java.util.List;
+import org.springframework.data.annotation.ReadOnlyProperty;
+


Same comment on describing contests from other files, also what is a GetAssertionsRequest?

I cleaned this up a bit, but lmk if it still doesn't make sense.

michelleblom · 2024-03-27T23:49:09Z

src/main/java/au/org/democracydevelopers/raireservice/request/RequestValidationException.java

+*/
+
+package au.org.democracydevelopers.raireservice.request;
+


Worth adding a class description to indicate what this kind of exception means.

...a/au/org/democracydevelopers/raireservice/persistence/repository/ContestRepositoryTests.java

michelleblom · 2024-03-27T23:51:36Z

src/test/resources/application.properties

@@ -1,3 +1,4 @@
 spring.datasource.driver-class-name=org.testcontainers.jdbc.ContainerDatabaseDriver
 spring.jpa.hibernate.ddl-auto=create


Have a look at what I have done for this file in the CVR retrieval branch.

Yes that's a huge improvement, thanks. I won't pull it into this branch, but definitely main should be that.

michelleblom · 2024-03-27T23:52:04Z

src/test/resources/data.sql

@@ -0,0 +1,16 @@
+-- Contest


Have a look at what I have done for this file in the CVR retrieval branch (as well as the added corla.sql schema).

vteague added 25 commits March 22, 2024 08:00

Stub for contest repository tests.

e20631a

Stub for Contest.

7e5482c

Contest Repository stub.

4c36a3d

Organized ContestRepositoryTest.

8a6dc8f

Scratch Contest Repository Tests.

8ada915

Edits to contest tests.

a4e24f1

Trivial tests passing.

36ac4b0

Trivial tests passing.

c304230

Trivial tests passing. I have included the data.sql and schema.sql fi…

27a83bf

…les, even though they are not quite set up right, and a trivial test of correct setup (which does not currently pass).

Removed lombok.

eed2eab

Removed logstash.

023a6da

Code cleanup.

e7360d8

Code cleanup.

5d4263f

Start on input validation.

e309af6

Start on input validation.

225c198

Get Assertions Request validation and tests.

4880a8e

Get Assertions Request validation and tests.

e2e34af

Start on GenerateAssertionsRequest validation.

fe48915

Update ContestRepository.java and tests to find first rather than all…

7265744

… contests by name.

Testing with pre-loaded test database rows.

fb343b5

Cleaned up ContestRepositoryTests and GetAssertionsRequestTests.

e8fad11

More test cleanup.

11267a8

Complete ContestRepositoryTests.

994e3e6

More GenerateAssertionsRequestTests

34ca95c

Logging.

35aaccb

vteague self-assigned this Mar 24, 2024

This was referenced Mar 24, 2024

Contest class; database retrieval; test #34

Closed

Implement classes for requests to raire-service from colorado-rla #38

Closed

Validate generate-assertion, get-assertion requests #39

Closed

vteague requested a review from michelleblom March 24, 2024 05:01

michelleblom requested changes Mar 24, 2024

View reviewed changes

vteague added 4 commits March 26, 2024 21:27

Changed ConcreteSTV to raire-service.

8247c12

Private members with getters.

45202d7

Better commenting, naming and protection in GenerateAssertionsRequest…

34b7524

….java

Better commenting, naming and protection in GenerateAssertionsRequest…

663f723

….java

vteague and others added 7 commits March 27, 2024 17:57

Requested changes from @michelleblom.

9eb8f2c

Removed (countyID, contestID) pairs from GenerateAssertionsRequest.java.

d65b904

Removed CountyAndContestID; fixed warnings.

4208253

Refactored common elements of GenerateAssertionsRequest.java and GetA…

c2379f8

…ssertionsRequest.java into an abstract superclass called ContestRequest.java

Merge pull request #52 from DemocracyDevelopers/RefactorRequests

9a2d649

Refactored common elements of GenerateAssertionsRequest.java and GetA…

Improved commenting.

35631a5

Corrected copyright msg.

d7db894

michelleblom requested changes Mar 27, 2024

View reviewed changes

Improved commenting.

45795c2

michelleblom approved these changes Mar 28, 2024

View reviewed changes

michelleblom merged commit 266f6e7 into main Mar 28, 2024
1 check passed

vteague mentioned this pull request Apr 1, 2024

Refactor GenerateAssertionsRequest and GetAssertionsRequest #51

Closed

vteague deleted the InputVerification branch April 23, 2024 06:05

vteague added this to the RAIRE Assertion Generator milestone May 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Input verification #48

Input verification #48

vteague commented Mar 24, 2024

michelleblom left a comment •

edited

Loading

michelleblom Mar 24, 2024

michelleblom Mar 25, 2024

michelleblom Mar 25, 2024

michelleblom Mar 25, 2024

vteague Mar 26, 2024

vteague commented Mar 27, 2024

michelleblom Mar 27, 2024

vteague Mar 28, 2024

michelleblom Mar 27, 2024

michelleblom Mar 27, 2024

vteague Mar 28, 2024

michelleblom Mar 27, 2024

		@@ -1,3 +1,4 @@
		spring.datasource.driver-class-name=org.testcontainers.jdbc.ContainerDatabaseDriver
		spring.jpa.hibernate.ddl-auto=create

		*/

		package au.org.democracydevelopers.raireservice.request;

Input verification #48

Input verification #48

Conversation

vteague commented Mar 24, 2024

michelleblom left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vteague commented Mar 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michelleblom left a comment •

edited

Loading