OpenTally/tests/aec.rs

/*  OpenTally: Open-source election vote counting
 *  Copyright © 2021 Lee Yingtong Li (RunasSudo)
 *
 *  This program is 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.
 *
 *  This program is 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 */

use opentally::election::{CandidateState, CountState, Election};
use opentally::numbers::{Number, Rational};
use opentally::stv;

use csv::StringRecord;
use flate2::bufread::GzDecoder;

use std::fs::File;
use std::io::{self, BufRead};

#[test]
fn aec_tas19_rational() {
	// Read CSV file
	let reader = csv::ReaderBuilder::new()
		.has_headers(false)
		.from_path("tests/data/aec-senate-formalpreferences-24310-TAS.csv")
		.expect("IO Error");
	let records: Vec<StringRecord> = reader.into_records().map(|r| r.expect("Syntax Error")).collect();
	
	let mut candidates: Vec<&str> = records.iter().skip(2).map(|r| &r[0]).collect();
	// Remove exhausted/LBF rows
	candidates.truncate(candidates.len() - 2);
	
	let stages: Vec<usize> = records.first().unwrap().iter().skip(1).step_by(2).map(|s| s.parse().unwrap()).collect();
	
	// Decompress BLT
	let file = File::open("tests/data/aec-senate-formalpreferences-24310-TAS.blt.gz").expect("IO Error");
	let file_reader = io::BufReader::new(file);
	let gz_decoder = GzDecoder::new(file_reader);
	let gz_reader = io::BufReader::new(gz_decoder);
	let lines = gz_reader.lines();
	
	// Read BLT
	let election: Election<Rational> = Election::from_blt(lines.map(|r| r.expect("IO Error").to_string()).into_iter());
	
	// TODO: Validate candidate names
	
	// Initialise options
	let stv_opts = stv::STVOptions {
		round_votes: Some(0),
		surplus: stv::SurplusMethod::UIG,
		surplus_order: stv::SurplusOrder::ByOrder,
		transferable_only: false,
		exclusion: stv::ExclusionMethod::ByValue,
		pp_decimals: 2,
	};
	
	// Initialise count state
	let mut state = CountState::new(&election);
	
	// Distribute first preferences
	stv::count_init(&mut state, &stv_opts);
	let mut stage_num = 1;
	
	for (idx, stage) in stages.into_iter().enumerate() {
		while stage_num < stage {
			// Step through stages
			// Assert count not yet done
			assert_eq!(stv::count_one_stage(&mut state, &stv_opts), false);
			stage_num += 1;
		}
		validate_stage(idx, &state, &records);
	}
}

fn validate_stage<N: Number>(idx: usize, state: &CountState<N>, records: &Vec<StringRecord>) {
	// Validate candidate votes
	let mut candidate_votes: Vec<N> = records.iter().skip(2).map(|r| N::parse(&r[idx*2 + 1])).collect();
	// Remove exhausted/LBF rows
	candidate_votes.truncate(candidate_votes.len() - 2);
	
	for (candidate, votes) in state.election.candidates.iter().zip(candidate_votes) {
		let count_card = state.candidates.get(candidate).unwrap();
		assert!(count_card.votes == votes);
	}
	
	// Validate candidate states
	let mut candidate_states: Vec<&str> = records.iter().skip(2).map(|r| &r[idx*2 + 2]).collect();
	candidate_states.truncate(candidate_states.len() - 2);
	
	for (candidate, candidate_state) in state.election.candidates.iter().zip(candidate_states) {
		let count_card = state.candidates.get(candidate).unwrap();
		if candidate_state == "" {
			assert!(count_card.state == CandidateState::HOPEFUL);
		} else if candidate_state == "EL" || candidate_state == "PEL" {
			assert!(count_card.state == CandidateState::ELECTED);
		} else if candidate_state == "EX" || candidate_state == "EXCLUDING" {
			assert!(count_card.state == CandidateState::EXCLUDED);
		} else {
			panic!("Unknown state descriptor {}", candidate_state);
		}
	}
}