Merge pull request #130 from DemocracyDevelopers/76-irvcomparisonaudit

76 irvcomparisonaudit

server/eclipse-project/src/main/java/au/org/democracydevelopers/corla/model/assertion/NEBAssertion.java

@@ -77,4 +77,15 @@ else if(loser_index != -1 && (winner_index == -1 || loser_index < winner_index))
         prefix, score, id(), contestName, info.choices()));
     return score;
   }
+
+
+  /**
+   * {@inheritDoc}
+   */
+  public String getDescription(){
+    return String.format("%s NEB %s: oneOver = %d; two Over = %d; oneUnder = %d, twoUnder = %d; " +
+        "other = %d; optimistic = %d; estimated = %d; risk %f.", winner, loser, oneVoteOverCount,
+        twoVoteOverCount, oneVoteUnderCount, twoVoteUnderCount, otherCount, optimisticSamplesToAudit,
+        estimatedSamplesToAudit, currentRisk);
+  }
 }

server/eclipse-project/src/main/java/au/org/democracydevelopers/corla/model/assertion/NENAssertion.java

@@ -22,7 +22,6 @@
 package au.org.democracydevelopers.corla.model.assertion;
 
 import java.util.List;
-import java.util.stream.Collectors;
 import javax.persistence.DiscriminatorValue;
 import javax.persistence.Entity;
 import org.apache.log4j.LogManager;
@@ -82,4 +81,14 @@ else if (choices_left.get(0).equals(loser)) {
     return score;
   }
 
+  /**
+   * {@inheritDoc}
+   */
+  public String getDescription(){
+    return String.format("%s NEN %s assuming (%s) are continuing: oneOver = %d; two Over = %d; " +
+        "oneUnder = %d, twoUnder = %d; other = %d; optimistic = %d; estimated = %d; risk %f.",
+        winner, loser, assumedContinuing, oneVoteOverCount, twoVoteOverCount, oneVoteUnderCount,
+        twoVoteUnderCount, otherCount, optimisticSamplesToAudit, estimatedSamplesToAudit, currentRisk);
+  }
+
 }

server/eclipse-project/src/main/java/au/org/democracydevelopers/corla/query/AssertionQueries.java

@@ -0,0 +1,84 @@
+/*
+Democracy Developers IRV extensions to colorado-rla.
+
+@copyright 2024 Colorado Department of State
+
+These IRV extensions are designed to connect to a running instance of the raire
+service (https://github.com/DemocracyDevelopers/raire-service), in order to
+generate assertions that can be audited using colorado-rla.
+
+The colorado-rla IRV extensions are free software: you can redistribute it and/or modify it under the terms
+of the GNU Affero General Public License as published by the Free Software Foundation, either
+version 3 of the License, or (at your option) any later version.
+
+The colorado-rla IRV extensions are distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with
+raire-service. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+package au.org.democracydevelopers.corla.query;
+
+import java.util.ArrayList;
+import java.util.List;
+import org.apache.log4j.LogManager;
+import org.apache.log4j.Logger;
+
+import org.hibernate.Session;
+import au.org.democracydevelopers.corla.model.assertion.Assertion;
+import us.freeandfair.corla.persistence.Persistence;
+
+import javax.persistence.TypedQuery;
+
+/**
+ * This class contains database queries relating to the retrieval of Assertions from the
+ * database. It contains a method that executes a query to retrieval all Assertions belonging
+ * to a specific contest, identified by name.
+ */
+public class AssertionQueries {
+
+  /**
+   * Class-wide logger.
+   */
+  public static final Logger LOGGER = LogManager.getLogger(AssertionQueries.class);
+
+  /**
+   * Retrieve all assertions in the database belonging to the contest with the given name.
+   *
+   * @param contestName The contest name.
+   * @return the list of assertions defined for the contest.
+   * @throws RuntimeException when an unexpected error arose in assertion retrieval (not including
+   * a NoResultException, which is handled by returning an empty list).
+   */
+  public static List<Assertion> matching(final String contestName) throws RuntimeException {
+    final String prefix = "[matching]";
+    try {
+      LOGGER.debug(String.format("%s Select query on assertion table, retrieving all " +
+          "assertions for contest with name %s.", prefix, contestName));
+
+      final Session s = Persistence.currentSession();
+      final TypedQuery<Assertion> q = s.createQuery("select ca from Assertion ca "
+            + " where ca.contestName = :contestName", Assertion.class);
+      q.setParameter("contestName", contestName);
+
+      List<Assertion> result = q.getResultList();
+      LOGGER.debug(String.format("%s %d assertions retrieved for contest %s.", prefix,
+          result.size(), contestName));
+      return result;
+
+    } catch (javax.persistence.NoResultException e) {
+      final String msg = String.format("%s No assertions retrieved for contest %s.", prefix,
+          contestName);
+      LOGGER.warn(msg);
+      return new ArrayList<>();
+    }
+    catch(Exception e){
+      final String msg = String.format("%s An error arose when attempting to retrieve assertions " +
+          "for contest %s: %s", prefix, contestName, e.getMessage());
+      LOGGER.error(msg);
+      throw new RuntimeException(msg);
+    }
+  }
+}

server/eclipse-project/src/main/java/us/freeandfair/corla/model/ComparisonAudit.java

@@ -30,6 +30,8 @@
 import javax.persistence.CollectionTable;
 import javax.persistence.Column;
 import javax.persistence.Convert;
+import javax.persistence.DiscriminatorColumn;
+import javax.persistence.DiscriminatorValue;
 import javax.persistence.ElementCollection;
 import javax.persistence.Entity;
 import javax.persistence.EnumType;
@@ -38,6 +40,8 @@
 import javax.persistence.GeneratedValue;
 import javax.persistence.GenerationType;
 import javax.persistence.Id;
+import javax.persistence.Inheritance;
+import javax.persistence.InheritanceType;
 import javax.persistence.JoinColumn;
 import javax.persistence.JoinTable;
 import javax.persistence.ManyToMany;
@@ -63,7 +67,9 @@
 @Entity
 @Cacheable(true)
 @Table(name = "comparison_audit")
-
+@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
+@DiscriminatorColumn(name = "audit_type")
+@DiscriminatorValue("PLURALITY")
 @SuppressWarnings({"PMD.ImmutableField", "PMD.ExcessiveClassLength",
     "PMD.CyclomaticComplexity", "PMD.GodClass", "PMD.ModifiedCyclomaticComplexity",
     "PMD.StdCyclomaticComplexity", "PMD.TooManyFields", "PMD.TooManyMethods",
@@ -129,11 +135,12 @@ public class ComparisonAudit implements PersistentEntity {
           private BigDecimal my_gamma = Audit.GAMMA;
 
   /**
-   * The diluted margin
+   * The diluted margin. [Democracy Developers: this must be accessible and modifiable by
+   * child classes of ComparisonAudit, hence we have made this attribute protected.]
    */
   @Column(updatable = false, nullable = false,
           precision = PRECISION, scale = SCALE)
-          private BigDecimal diluted_margin = BigDecimal.ONE;
+          protected BigDecimal diluted_margin = BigDecimal.ONE;
 
   /**
    * The risk limit.
@@ -150,16 +157,20 @@ public class ComparisonAudit implements PersistentEntity {
 
   /**
    * The number of samples to audit overall assuming no further overstatements.
+   * [Democracy Developers: this must be accessible and modifiable by child classes of
+   * ComparisonAudit, hence we have made this attribute protected.]
    */
   @Column(nullable = false)
-  private Integer my_optimistic_samples_to_audit = 0;
+  protected Integer my_optimistic_samples_to_audit = 0;
 
   /**
    * The expected number of samples to audit overall assuming overstatements
    * continue at the current rate.
+   * [Democracy Developers: this must be accessible and modifiable by child classes of
+   * ComparisonAudit, hence we have made this attribute protected.]
    */
   @Column(nullable = false)
-  private Integer my_estimated_samples_to_audit = 0;
+  protected Integer my_estimated_samples_to_audit = 0;
 
   /**
    * The number of two-vote understatements recorded so far.
@@ -207,16 +218,20 @@ public class ComparisonAudit implements PersistentEntity {
   /**
    * A flag that indicates whether the optimistic ballots to audit
    * estimate needs to be recalculated.
+   * [Democracy Developers: this must be accessible and modifiable by child classes of
+   * ComparisonAudit, hence we have made this attribute protected.]
    */
   @Column(nullable = false)
-  private Boolean my_optimistic_recalculate_needed = true;
+  protected Boolean my_optimistic_recalculate_needed = true;
 
   /**
    * A flag that indicates whether the non-optimistic ballots to
-   * audit estimate needs to be recalculated
+   * audit estimate needs to be recalculated.
+   * [Democracy Developers: this must be accessible and modifiable by child classes of
+   * ComparisonAudit, hence we have made this attribute protected.]
    */
   @Column(nullable = false)
-  private Boolean my_estimated_recalculate_needed = true;
+  protected Boolean my_estimated_recalculate_needed = true;
 
   /**
    * The sequence of CastVoteRecord ids for this contest ordered by County id

server/eclipse-project/src/main/resources/us/freeandfair/corla/persistence/entity_classes

@@ -23,3 +23,4 @@ us.freeandfair.corla.model.UploadedFile
 au.org.democracydevelopers.corla.model.assertion.Assertion
 au.org.democracydevelopers.corla.model.assertion.NEBAssertion
 au.org.democracydevelopers.corla.model.assertion.NENAssertion
+au.org.democracydevelopers.corla.model.IRVComparisonAudit