Add Github action

Author: gnossen

elections/tools/.github/workflows/tally.yml

@@ -0,0 +1,18 @@
+name: Tally Elections Tool
+run-name: Test Tally Elections Tool
+on:
+  pull_request:
+    paths:
+    - 'elections/tools/**'
+jobs:
+  tally_test:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "The name of the branch is ${{ github.ref }} and the repository is ${{ github.repository }}."
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.24.x'
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Run unit tests and fuzzer
+        run: cd ${{ github.workspace }} && make fuzztimed

elections/tools/Makefile

@@ -23,6 +23,14 @@ test:
 fuzz:
 	go test -v -fuzz=Fuzz ./pkg/score/
 
+.PHONY: fuzztimed
+fuzztimed:
+	go test -v -fuzz=Fuzz -fuzztime=60s ./pkg/score/
+
+.PHONY: fmt
+fmt:
+	go fmt ./...
+
 .PHONY: clean
 clean:
 	rm -f ${ARTIFACTS}

elections/tools/README.md

@@ -3,4 +3,15 @@
 This directory contains tooling used to conduct the annual gRPC Steering
 Committee elections.
 
-TODO: Usage instructions
+First, write a config file using [the example config](examples/config.yaml) as a
+guide. If you have not changed the ballot format since the last election, the
+only change you will need to make is the list of candidates.
+
+To generate a results markdown file given a CSV of ballots, use the following command:
+
+```
+go run ./cmd/tally.go [VOTES_CSV] -c [CONFIG_FILE]
+```
+
+This will generate a markdown file at `results.md` with the results of the
+election.

elections/tools/cmd/tally.go

@@ -152,6 +152,11 @@ func generateResultsMarkdown(candidates []string, responseCount int, winners, lo
 
 		sb.WriteString("## Instant Run-Off Elimination\n")
 		sb.WriteString("Candidates were eliminated according to the Condorcet IRV method in the following order:\n")
+
+		if len(losers) == 0 {
+			sb.WriteString("\n*no candidates were eliminated*\n")
+		}
+
 		for _, loser := range losers {
 			sb.WriteString(fmt.Sprintf("- %s\n", candidates[loser]))
 		}

elections/tools/pkg/score/score_fuzz_test.go

@@ -56,7 +56,7 @@ func lehmerCodeToRow(lehmer int, elementCount int) []int {
 }
 
 func rowEncodingToRows(rowEncoding []byte, numCandidates, numVoters int) [][]int {
-	// We'll draw `numVoters` permutations from the byte slice. If there are no remaining bytes, we will assume the next row is a 0.
+	// We draw `numVoters` permutations from the byte slice. If there are no remaining bytes, we will assume the next row is a 0.
 	// Each row will be a Lehmer Code represented by ceil(ceil(log_2(numCandidates!)) / 8) bytes.
 
 	// So we will draw no more than numVoters * ceil(ceil(log_2(numCandidates!)) / 8) bytes from the slice.