Add missing files.

Author: vteague

server/eclipse-project/src/main/java/au/org/democracydevelopers/corla/endpoint/GenerateAssertions.java

@@ -39,6 +39,7 @@
 import us.freeandfair.corla.Main;
 import us.freeandfair.corla.model.Choice;
 import us.freeandfair.corla.model.ContestResult;
+import us.freeandfair.corla.persistence.Persistence;
 
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
@@ -166,6 +167,9 @@ public String endpointBody(final Request the_request, final Response the_respons
       serverError(the_response, e.getMessage());
     }
 
+    // The only change is updating the winners in the IRV ContestResults.
+    Persistence.flush();
+
     return my_endpoint_result.get();
   }
 
@@ -255,6 +259,9 @@ protected GenerateAssertionsResponseWithErrors generateAssertionsUpdateWinners(L
         GenerateAssertionsResponse responseFromRaire = Main.GSON.fromJson(EntityUtils.toString(raireResponse.getEntity()),
             GenerateAssertionsResponse.class);
 
+        // Update the contestRequest with a winner from raire.
+        updateWinnerAndLosers(cr, candidates, responseFromRaire.winner);
+
         LOGGER.debug(String.format("%s %s %s.", prefix,
             "Completed assertion generation for contest", contestName));
         return new GenerateAssertionsResponseWithErrors(contestName, responseFromRaire.winner, "");
@@ -267,6 +274,9 @@ protected GenerateAssertionsResponseWithErrors generateAssertionsUpdateWinners(L
         LOGGER.debug(String.format("%s %s %s.", prefix, "Error response " + code,
             "received from RAIRE for " + contestName));
 
+        // Update the contestRequest with a blank winner.
+        updateNoWinnerAndAllLosers(cr, candidates);
+
         LOGGER.debug(String.format("%s %s %s.", prefix,
             "Error response for assertion generation for contest ", contestName));
         return new GenerateAssertionsResponseWithErrors(cr.getContestName(), UNKNOWN_WINNER, code);
@@ -321,6 +331,29 @@ protected GenerateAssertionsResponseWithErrors generateAssertionsUpdateWinners(L
     }
   }
 
+  /**
+   * Update the contestResults in the database for failed assertion generation: no winners.
+   * Set all candidates as losers.
+   * @param cr         the contestResult to be updated.
+   * @param candidates the candidates.
+   */
+  private void updateNoWinnerAndAllLosers(ContestResult cr, List<String> candidates) {
+    cr.setWinners(Set.of());
+    cr.setLosers(new HashSet<>(candidates));
+  }
+
+  /**
+   * Update the contestResults in the database according to RAIRE's assessed winners. Set all
+   * non-winners to be losers.
+   * @param cr         the contest result, i.e. aggregated (possibly cross-county) IRV contest.
+   * @param candidates the list of candidate names.
+   * @param winner     the winner, as determined by raire.
+   */
+  private void updateWinnerAndLosers(ContestResult cr, List<String> candidates, String winner) {
+    cr.setWinners(Set.of(winner));
+    cr.setLosers(candidates.stream().filter(c -> !c.equalsIgnoreCase(winner)).collect(Collectors.toSet()));
+  }
+
   /**
    * Validates the parameters of a request. For this endpoint, the query parameters are optional,
    * but if the contest is present it should be non-null, and if a time limit is present it should

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

@@ -0,0 +1,102 @@
+/*
+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.model;
+
+import org.apache.log4j.LogManager;
+import org.apache.log4j.Logger;
+
+import javax.persistence.*;
+
+import static java.util.Collections.min;
+
+
+/**
+ * RAIRE (raire-java) generates a set of assertions for a given IRV contest, but it also returns
+ * the winner and (possibly) an informative error. These are stored in the database, which
+ * colorado-rla needs to read in order to produce IRV reports. This is read-only table here, with
+ * data identical to the corresponding class in raire-service.
+ */
+@Entity
+@Table(name = "generate_assertions_summary")
+public class GenerateAssertionsSummary {
+
+  /**
+   * Class-wide logger.
+   */
+  private static final Logger LOGGER = LogManager.getLogger(GenerateAssertionsSummary.class);
+
+  /**
+   * ID.
+   */
+  @Id
+  @Column(updatable = false, nullable = false)
+  @GeneratedValue(strategy = GenerationType.IDENTITY)
+  private long id;
+
+  /**
+   * Version. Used for optimistic locking.
+   */
+  @Version
+  @Column(name = "version", updatable = false, nullable = false)
+  private long version;
+
+  /**
+   * Name of the contest.
+   */
+  @Column(name = "contest_name", unique = true, updatable = false, nullable = false)
+  public String contestName;
+
+  /**
+   * Name of the winner of the contest, as determined by raire-java.
+   */
+  @Column(name = "winner", updatable = false, nullable = false)
+  public String winner;
+
+  /**
+   * An error (matching one of the RaireServiceErrors.RaireErrorCodes), if there was one. Errors
+   * mean there are no assertions (nor winner), but some warnings
+   * (e.g. TIME_OUT_TRIMMING_ASSERTIONS) do have assertions and a winner, and allow the audit to
+   * continue.
+   */
+  @Column(name = "error", updatable = false, nullable = false)
+  public String error;
+
+  /**
+   * A warning, if there was one, or emptystring if none. Warnings (e.g. TIME_OUT_TRIMMING_ASSERTIONS)
+   * mean that assertion generation succeeded and the audit can continue, but re-running with longer
+   * time allowed might be beneficial.
+   */
+  @Column(name = "warning", updatable = false, nullable = false)
+  public String warning;
+
+  /**
+   * The message associated with the error, for example the names of the tied winners.
+   */
+  @Column(name = "message", updatable = false, nullable = false)
+  public String message;
+
+  /**
+   * Default no-args constructor (required for persistence).
+   */
+  public GenerateAssertionsSummary() {
+  }
+}

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

@@ -106,7 +106,8 @@ public IRVComparisonAudit() {
    * thrown if an unexpected error arises when retrieving assertions from the database, or in the
    * computation of optimistic and estimated sample sizes.
    *
-   * @param contestResult The contest result (identifies the contest under audit).
+   * @param contestResult The contest result (identifies the contest under audit). This is updated
+   *                      with the winner returned
    * @param riskLimit The risk limit.
    * @param auditReason The audit reason.
    */

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

@@ -0,0 +1,109 @@
+/*
+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 au.org.democracydevelopers.corla.model.GenerateAssertionsSummary;
+import au.org.democracydevelopers.corla.model.assertion.Assertion;
+import org.apache.log4j.LogManager;
+import org.apache.log4j.Logger;
+import org.hibernate.Session;
+import us.freeandfair.corla.persistence.Persistence;
+
+import javax.persistence.TypedQuery;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+import static au.org.democracydevelopers.corla.endpoint.GenerateAssertions.UNKNOWN_WINNER;
+
+/**
+ * Database queries relating to the retrieval of Assertion Generation Summaries from the
+ * database. It contains a method that executes a query to retrieval all GenerateAssertionsSummaries
+ * belonging to a specific contest, identified by name.
+ * Also includes a shortcut function to get the winner, which inserts UNKNOWN_WINNER if either the
+ * record is absent, or the winner is blank.
+ * TODO Currently these queries have no uses outside testing - if they are not needed for the UI,
+ * (e.g. giving feedback about assertion generation) they can be safely deleted.
+ */
+public class GenerateAssertionsSummaryQueries {
+
+  /**
+   * Class-wide logger.
+   */
+  public static final Logger LOGGER = LogManager.getLogger(GenerateAssertionsSummaryQueries.class);
+
+  /**
+   * Retrieve the winner of an IRV contest matching the given contestName, or UNKNOWN_WINNER if
+   * there is no record, or no winner in the record.
+   * @param contestName the name of the contest.
+   */
+  public static String matchingWinner(final String contestName) {
+    Optional<GenerateAssertionsSummary> optSummary = matching(contestName);
+    if(optSummary.isPresent() && !optSummary.get().winner.isBlank()) {
+      return optSummary.get().winner;
+    } else {
+      return UNKNOWN_WINNER;
+    }
+  }
+
+  /**
+   * Retrieve all summaries in the database belonging to the contest with the given name.
+   * @param contestName The contest name.
+   * @return the (optional) summary 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 optional item).
+   */
+  public static Optional<GenerateAssertionsSummary> matching(final String contestName) throws RuntimeException {
+    final String prefix = "[matching]";
+    try {
+      LOGGER.debug(String.format("%s Select query on generate assertions summary table, retrieving " +
+          "summary for contest with name %s.", prefix, contestName));
+
+      final Session s = Persistence.currentSession();
+      final TypedQuery<GenerateAssertionsSummary> q = s.createQuery("select ca from GenerateAssertionsSummary ca "
+            + " where ca.contestName = :contestName", GenerateAssertionsSummary.class);
+      q.setParameter("contestName", contestName);
+
+      List<GenerateAssertionsSummary> result = q.getResultList();
+      LOGGER.debug(String.format("%s %d summary results retrieved for contest %s.", prefix,
+          result.size(), contestName));
+      if(result.isEmpty()) {
+        // No summary was present for this contest. This is expected if GenerateAssertions has not run.
+        return Optional.empty();
+      } else if(result.size() == 1) {
+        // Expected unique summary, after a run of GenerateAssertions.
+        return Optional.of(result.get(0));
+      } else {
+        // Duplicate summaries - not expected, since contestName should be unique in the Generate
+        // Assertions Summary table.
+        throw new RuntimeException("Duplicate summaries for contest " + contestName);
+      }
+    }
+    catch(Exception e){
+      final String msg = String.format("%s An error arose when attempting to retrieve summary data" +
+          "for contest %s: %s", prefix, contestName, e.getMessage());
+      LOGGER.error(msg);
+      throw new RuntimeException(msg);
+    }
+  }
+
+}

server/eclipse-project/src/main/java/us/freeandfair/corla/report/ReportRows.java

@@ -40,6 +40,8 @@
 
 import us.freeandfair.corla.util.SuppressFBWarnings;
 
+import static au.org.democracydevelopers.corla.endpoint.GenerateAssertions.UNKNOWN_WINNER;
+
 /**
  *  Contains the query-ing and processing of two report types:
  *    activity and results
@@ -376,17 +378,12 @@ public static List<List<String>> genSumResultsReport() {
       row.put("Contest", ca.contestResult().getContestName());
       row.put("targeted", yesNo(ca.isTargeted()));
 
-      if(ca instanceof IRVComparisonAudit) {
-        // If IRV, get the winner's name from the GenerateAssertionsSummary.
-        row.put("Winner", GenerateAssertionsSummaryQueries.matchingWinner(ca.getContestName()));
+      if (ca.contestResult().getWinners() == null || ca.contestResult().getWinners().isEmpty()) {
+        LOGGER.info("no winner!!! " + ca);
+        row.put("Winner", UNKNOWN_WINNER);
       } else {
-        // Must be a plurality audit. ContestResult.winner is correct.
-        if (ca.contestResult().getWinners() == null || ca.contestResult().getWinners().isEmpty()) {
-          LOGGER.info("no winner!!! " + ca);
-        }
         row.put("Winner", toString(ca.contestResult().getWinners().iterator().next()));
       }
-      // All this data makes sense for both IRV and plurality.
       row.put("Risk Limit met?", yesNo(riskLimitMet(ca.getRiskLimit(), riskMsmnt)));
       row.put("Risk measurement %", sigFig(percentage(riskMsmnt), 1).toString());
       row.put("Audit Risk Limit %", sigFig(percentage(ca.getRiskLimit()),1).toString());