c2pa 0.82.0

// Copyright 2024 Adobe. All rights reserved.
// This file is licensed to you under the Apache License,
// Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
// or the MIT license (http://opensource.org/licenses/MIT),
// at your option.

// Unless required by applicable law or agreed to in writing,
// this software is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or
// implied. See the LICENSE-MIT and LICENSE-APACHE files for the
// specific language governing permissions and limitations under
// each license.

mod compare_readers;
mod test_signer;

use std::{
    fs,
    io::{Read, Seek},
    path::{Path, PathBuf},
};

use c2pa::{format_from_path, Context, Reader, Result, Settings};
pub use compare_readers::compare_readers;
#[allow(unused)] // different code path for WASI
use tempfile::{tempdir, TempDir};
#[allow(unused)]
pub use test_signer::test_signer;

/// Returns a [`Settings`] instance loaded from the standard test fixture TOML.
///
/// Use this instead of `Settings::new().with_toml(include_str!(...))` in test code.
#[allow(unused, clippy::expect_used)]
pub fn test_settings() -> Settings {
    Settings::new()
        .with_toml(include_str!("../fixtures/test_settings.toml"))
        .expect("built-in test_settings.toml should be valid")
}

/// Returns a [`Context`] configured with the standard test settings.
///
/// Use this instead of manually constructing `Settings` + `Context` in test code.
/// Call `.into_shared()` on the result if you need an `Arc<Context>`.
#[allow(unused, clippy::expect_used)]
pub fn test_context() -> Context {
    Context::new()
        .with_settings(test_settings())
        .expect("test_settings should always be valid")
}

#[allow(unused_macros)]
macro_rules! assert_err {
    ($expression:expr, $($pattern:tt)+) => {
        match $expression {
            $($pattern)+ => (),
            ref e => panic!("expected `{}` but got `{:?}`", stringify!($($pattern)+), e),
        }
    }
}
#[allow(unused_imports)]
pub(super) use assert_err;

pub fn fixtures_path<P: AsRef<Path>>(file_name: P) -> std::path::PathBuf {
    PathBuf::from("tests/fixtures").join(file_name)
}

pub fn known_good_path<P: AsRef<Path>>(file_name: P) -> std::path::PathBuf {
    PathBuf::from("tests/known_good").join(file_name)
}

/// get a file from path without requiring file_io feature enabled in the c2pa crate
pub fn reader_from_file<P: AsRef<Path>>(path: P) -> Result<Reader> {
    let format = format_from_path(&path).ok_or(c2pa::Error::UnsupportedType)?;
    Reader::default().with_stream(&format, &mut fs::File::open(&path)?)
}

#[allow(unused)]
pub fn write_known_good<P: AsRef<Path>>(file_name: P) -> Result<()> {
    let reader = reader_from_file(fixtures_path(&file_name))?;
    let mut path = known_good_path(file_name);
    path.set_extension("json");
    fs::write(path, reader.json()).map_err(Into::into)
}

pub fn read_known_good<P: AsRef<Path>>(file_name: P) -> std::io::Result<String> {
    let mut path = known_good_path(file_name);
    path.set_extension("json");
    fs::read_to_string(path)
}

#[allow(unused)]
pub fn compare_to_known_good<P: AsRef<Path>>(reader: &Reader, file_name: P) -> Result<()> {
    let known = read_known_good(&file_name)?;
    let reader1 = Reader::from_json(&known)?;
    //et reader2 = reader_from_file(fixtures_path(file_name))?;
    let result = compare_readers(&reader1, reader)?;
    assert!(result.is_empty(), "{}", result.join("\n"));
    Ok(())
}

#[allow(unused)]
pub fn compare_stream_to_known_good<P: AsRef<Path>, S: Read + Seek + Send>(
    stream: &mut S,
    format: &str,
    known_file: P,
) -> Result<()> {
    let known = read_known_good(&known_file)?;
    let reader1 = Reader::from_json(&known)?;
    let reader2 = Reader::default().with_stream(format, stream)?;
    let result = compare_readers(&reader1, &reader2)?;
    assert!(result.is_empty(), "{}", result.join("\n"));
    Ok(())
}

#[allow(unused)]
pub fn fixture_stream(name: &str) -> Result<(String, fs::File)> {
    let path = fixtures_path(name);
    let format = format_from_path(&path).ok_or(c2pa::Error::UnsupportedType)?;
    let stream = fs::File::open(&path)?;
    Ok((format, stream))
}

#[allow(unused)]
pub fn check_validation_status(reader: &Reader, code: &str) {
    if let Some(validation_statuses) = reader.validation_status() {
        assert!(
            validation_statuses
                .iter()
                .any(|status| status.code() == code),
            "Expected to find {code} in validation status"
        );
    } else {
        panic!("Expected to find validation status");
    }
}

#[allow(unused)]
pub fn tempdirectory() -> Result<TempDir> {
    #[cfg(target_os = "wasi")]
    return TempDir::new_in("/").map_err(c2pa::Error::IoError);

    #[cfg(not(target_os = "wasi"))]
    return tempdir().map_err(c2pa::Error::IoError);
}