bdrck 0.22.5

// Copyright 2015 Axel Rasmussen
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::configuration;
use crate::testing::temp;
use once_cell::sync::Lazy;
use serde::{Deserialize, Serialize};
use std::fs;
use std::path;

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
struct TestConfiguration {
    foo: String,
}

static TEST_IDENTIFIER: Lazy<configuration::Identifier> = Lazy::new(|| configuration::Identifier {
    application: "bdrck_config".to_owned(),
    name: "test".to_owned(),
});

#[test]
fn test_persistence() {
    crate::init().unwrap();

    let file = temp::File::new_file().unwrap();
    let path: path::PathBuf = file.path().to_owned();
    // Remove the file: an empty file isn't a valid serialized configuration struct.
    fs::remove_file(path.as_path()).unwrap();

    // Test that creating a configuration with an nonexistent file uses the default.
    let default = TestConfiguration {
        foo: "this is test data".to_owned(),
    };
    configuration::new(
        TEST_IDENTIFIER.clone(),
        default.clone(),
        Some(path.as_path()),
    )
    .ok()
    .unwrap();
    assert_eq!(default, configuration::get(&TEST_IDENTIFIER).ok().unwrap());

    // Test that when we update the configuration, the new version is persisted,
    // and is re-loaded upon recreation.
    let updated = TestConfiguration {
        foo: "this is some other test data".to_owned(),
    };
    configuration::set(&TEST_IDENTIFIER, updated.clone())
        .ok()
        .unwrap();
    assert_eq!(updated, configuration::get(&TEST_IDENTIFIER).ok().unwrap());
    configuration::remove::<TestConfiguration>(&TEST_IDENTIFIER)
        .ok()
        .unwrap();
    configuration::new(
        TEST_IDENTIFIER.clone(),
        default.clone(),
        Some(path.as_path()),
    )
    .ok()
    .unwrap();
    assert_eq!(updated, configuration::get(&TEST_IDENTIFIER).ok().unwrap());

    // Test that we can then reset back to defaults.
    configuration::reset::<TestConfiguration>(&TEST_IDENTIFIER)
        .ok()
        .unwrap();
    assert_eq!(default, configuration::get(&TEST_IDENTIFIER).ok().unwrap());

    // Clean up so later tests don't pick up this singleton.
    configuration::remove::<TestConfiguration>(&TEST_IDENTIFIER)
        .ok()
        .unwrap();
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
struct OtherConfiguration {
    bar: i32,
}

fn err_id(name: &str) -> configuration::Identifier {
    configuration::Identifier {
        application: "bdrck_config_errors".to_owned(),
        name: name.to_owned(),
    }
}

#[test]
fn test_operations_on_unknown_identifier() {
    crate::init().unwrap();

    // None of these register the id in the singleton map; every call should
    // return an InvalidArgument "unrecognized configuration identifier" error.
    let id = err_id("never_registered");
    assert!(configuration::get::<TestConfiguration>(&id).is_err());
    assert!(
        configuration::set::<TestConfiguration>(
            &id,
            TestConfiguration {
                foo: "x".to_owned()
            },
        )
        .is_err()
    );
    assert!(configuration::reset::<TestConfiguration>(&id).is_err());
    assert!(configuration::persist::<TestConfiguration>(&id).is_err());
    assert!(configuration::remove::<TestConfiguration>(&id).is_err());
}

#[test]
fn test_operations_with_wrong_type() {
    crate::init().unwrap();

    let id = err_id("wrong_type");
    let file = temp::File::new_file().unwrap();
    let path = file.path().to_owned();
    fs::remove_file(path.as_path()).unwrap();

    // Register a TestConfiguration singleton under this id.
    configuration::new(
        id.clone(),
        TestConfiguration {
            foo: "v".to_owned(),
        },
        Some(path.as_path()),
    )
    .unwrap();

    // Every accessor for a different T should return "wrong type specified".
    assert!(configuration::get::<OtherConfiguration>(&id).is_err());
    assert!(configuration::set::<OtherConfiguration>(&id, OtherConfiguration { bar: 42 }).is_err());
    assert!(configuration::reset::<OtherConfiguration>(&id).is_err());
    assert!(configuration::persist::<OtherConfiguration>(&id).is_err());
    assert!(configuration::remove::<OtherConfiguration>(&id).is_err());

    // Clean up so later tests don't pick up this singleton.
    configuration::remove::<TestConfiguration>(&id)
        .ok()
        .unwrap();
}