mod.rs

use std::collections::BTreeMap;
use std::fs::File;
use std::io::{self, BufReader, Write};
use std::path::PathBuf;

use blake2b_simd::State as Blake2b;
use failure::Error as FailureError;
use rand::{thread_rng, Rng};
use storage_proofs_core::parameter_cache::{ParameterData, ParameterMap};

use crate::support::tmp_manifest;

mod session;

use session::ParamFetchSessionBuilder;

/// Produce a random sequence of bytes and first 32 characters of hex encoded
/// BLAKE2b checksum. This helper function must be kept up-to-date with the
/// parampublish implementation.
fn rand_bytes_with_blake2b() -> Result<(Vec<u8>, String), FailureError> {
    let bytes = thread_rng().gen::<[u8; 32]>();

    let mut hasher = Blake2b::new();

    let mut as_slice = &bytes[..];

    io::copy(&mut as_slice, &mut hasher)?;

    Ok((bytes.to_vec(), hasher.finalize().to_hex()[..32].into()))
}

fn clean_up_manifest_and_parent(manifest_pbuf: &PathBuf) {
    let parent_dir = std::path::Path::new(manifest_pbuf)
        .parent()
        .expect("failed to get parent dir");
    std::fs::remove_file(manifest_pbuf).expect("failed to remove manifest file");
    std::fs::remove_dir_all(parent_dir).expect("failed to remove parent dir");
}

#[test]
fn nothing_to_fetch_if_cache_fully_hydrated() -> Result<(), FailureError> {
    let mut manifest: BTreeMap<String, ParameterData> = BTreeMap::new();

    let (aaa_bytes, aaa_checksum) = rand_bytes_with_blake2b()?;
    let mut aaa_bytes: &[u8] = &aaa_bytes;

    // manifest entry checksum matches the BLAKE2b we compute locally
    manifest.insert(
        "aaa.vk".to_string(),
        ParameterData {
            cid: "".to_string(),
            digest: aaa_checksum,
            sector_size: 1234,
        },
    );

    let manifest_pbuf = tmp_manifest(Some(manifest))?;

    let mut session = ParamFetchSessionBuilder::new(Some(manifest_pbuf.clone()))
        .with_session_timeout_ms(1000)
        .with_file_and_bytes("aaa.vk", &mut aaa_bytes)
        .build();

    session.exp_string("determining if file is out of date: aaa.vk")?;
    session.exp_string("file is up to date")?;
    session.exp_string("no outdated files, exiting")?;

    clean_up_manifest_and_parent(&manifest_pbuf);
    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn prompts_to_download_if_file_in_manifest_is_missing() -> Result<(), FailureError> {
    let mut manifest: BTreeMap<String, ParameterData> = BTreeMap::new();

    manifest.insert(
        "aaa.vk".to_string(),
        ParameterData {
            cid: "".to_string(),
            digest: "".to_string(),
            sector_size: 1024,
        },
    );

    let manifest_pbuf = tmp_manifest(Some(manifest))?;

    let mut session = ParamFetchSessionBuilder::new(Some(manifest_pbuf.clone()))
        .with_session_timeout_ms(1000)
        .build();

    session.exp_string("determining if file is out of date: aaa.vk")?;
    session.exp_string("file not found, marking for download")?;
    session.exp_string("Select files to be downloaded")?;
    session.exp_string("aaa.vk (1 KiB)")?;

    clean_up_manifest_and_parent(&manifest_pbuf);
    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn prompts_to_download_if_file_checksum_does_not_match_manifest() -> Result<(), FailureError> {
    let mut manifest: BTreeMap<String, ParameterData> = BTreeMap::new();

    let (aaa_bytes, _) = rand_bytes_with_blake2b()?;
    let mut aaa_bytes: &[u8] = &aaa_bytes;

    manifest.insert(
        "aaa.vk".to_string(),
        ParameterData {
            cid: "".to_string(),
            digest: "obviouslywrong".to_string(),
            sector_size: 1024,
        },
    );

    let manifest_pbuf = tmp_manifest(Some(manifest))?;

    let mut session = ParamFetchSessionBuilder::new(Some(manifest_pbuf.clone()))
        .with_session_timeout_ms(1000)
        .with_file_and_bytes("aaa.vk", &mut aaa_bytes)
        .build();

    session.exp_string("determining if file is out of date: aaa.vk")?;
    session.exp_string("params file found")?;
    session.exp_string("file has unexpected digest, marking for download")?;
    session.exp_string("Select files to be downloaded")?;
    session.exp_string("aaa.vk (1 KiB)")?;

    clean_up_manifest_and_parent(&manifest_pbuf);
    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn fetches_vk_even_if_sector_size_does_not_match() -> Result<(), FailureError> {
    let mut manifest: BTreeMap<String, ParameterData> = BTreeMap::new();

    manifest.insert(
        "aaa.params".to_string(),
        ParameterData {
            cid: "".to_string(),
            digest: "".to_string(),
            sector_size: 1024,
        },
    );

    manifest.insert(
        "aaa.vk".to_string(),
        ParameterData {
            cid: "".to_string(),
            digest: "".to_string(),
            sector_size: 1024,
        },
    );

    let manifest_pbuf = tmp_manifest(Some(manifest))?;

    let mut session = ParamFetchSessionBuilder::new(Some(manifest_pbuf.clone()))
        .with_session_timeout_ms(1000)
        .whitelisted_sector_sizes(vec!["6666".to_string(), "4444".to_string()])
        .build();

    session.exp_string("json contains 2 files")?;
    session.exp_string("ignoring file: aaa.params (1 KiB)")?;
    session.exp_string("determining if file is out of date: aaa.vk")?;
    session.exp_string("file not found, marking for download")?;

    clean_up_manifest_and_parent(&manifest_pbuf);
    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn invalid_json_path_produces_error() -> Result<(), FailureError> {
    let mut session = ParamFetchSessionBuilder::new(Some(PathBuf::from("/invalid/path")))
        .with_session_timeout_ms(1000)
        .build();

    session.exp_string("using json file: /invalid/path")?;
    session.exp_string("failed to open json file, exiting")?;

    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn invalid_json_produces_error() -> Result<(), FailureError> {
    let manifest_pbuf = tmp_manifest(None)?;

    {
        let mut file = File::create(&manifest_pbuf)?;
        file.write_all(b"invalid json")?;
    }

    let mut session = ParamFetchSessionBuilder::new(Some(manifest_pbuf.clone()))
        .with_session_timeout_ms(1000)
        .build();

    session.exp_string("failed to parse json file, exiting")?;

    clean_up_manifest_and_parent(&manifest_pbuf);
    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}

#[test]
fn no_json_path_uses_default_manifest() -> Result<(), FailureError> {
    let file = File::open("../parameters.json")?;
    let reader = BufReader::new(file);
    let manifest: ParameterMap = serde_json::from_reader(reader)?;

    let mut session = ParamFetchSessionBuilder::new(None)
        .with_session_timeout_ms(1000)
        .build();

    session.exp_string("using built-in json")?;

    for parameter in manifest.keys() {
        session.exp_string(&format!(
            "determining if file is out of date: {}",
            parameter
        ))?;
    }

    std::fs::remove_dir_all(session._cache_dir.path())?;

    Ok(())
}