1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

// Copyright 2019-2024 ChainSafe Systems
// SPDX-License-Identifier: Apache-2.0, MIT

//! Migration logic from any version that requires no migration logic.

use crate::db::migration::migration_map::temporary_db_name;
use crate::Config;
use fs_extra::dir::CopyOptions;
use semver::Version;
use std::path::{Path, PathBuf};
use tracing::info;

use super::migration_map::MigrationOperation;

pub(super) struct MigrationVoid {
    from: Version,
    to: Version,
}

impl MigrationOperation for MigrationVoid {
    fn pre_checks(&self, _chain_data_path: &Path) -> anyhow::Result<()> {
        Ok(())
    }

    fn migrate(&self, chain_data_path: &Path, _config: &Config) -> anyhow::Result<PathBuf> {
        let source_db = chain_data_path.join(self.from.to_string());

        let temp_db_path = chain_data_path.join(temporary_db_name(&self.from, &self.to));
        if temp_db_path.exists() {
            info!(
                "removing old temporary database {temp_db_path}",
                temp_db_path = temp_db_path.display()
            );
            std::fs::remove_dir_all(&temp_db_path)?;
        }

        info!(
            "copying old database from {source_db} to {temp_db_path}",
            source_db = source_db.display(),
            temp_db_path = temp_db_path.display()
        );
        fs_extra::copy_items(
            &[source_db.as_path()],
            temp_db_path.clone(),
            &CopyOptions::default().copy_inside(true),
        )?;

        Ok(temp_db_path)
    }

    fn post_checks(&self, chain_data_path: &Path) -> anyhow::Result<()> {
        let temp_db_name = temporary_db_name(&self.from, &self.to);
        if !chain_data_path.join(&temp_db_name).exists() {
            anyhow::bail!(
                "migration database {} does not exist",
                chain_data_path.join(temp_db_name).display()
            );
        }
        Ok(())
    }

    fn new(from: Version, to: Version) -> Self
    where
        Self: Sized,
    {
        Self { from, to }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use semver::Version;
    use tempfile::TempDir;

    #[test]
    fn test_migration_void() {
        let migration = MigrationVoid::new(Version::new(1, 0, 0), Version::new(1, 0, 1));
        let chain_data_path = TempDir::new().unwrap();

        // create a file in the temporary database directory, under a directory (to ensure that the
        // directory is copied recursively).
        let content_dir = chain_data_path.path().join("1.0.0").join("R'lyeh");
        std::fs::create_dir_all(&content_dir).unwrap();

        let content_file = content_dir.join("cthulhu");
        let chant = "ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fhtagn";
        std::fs::write(content_file, chant).unwrap();

        let path = chain_data_path.path();
        migration.pre_checks(path).unwrap();
        let temp_db_path = migration.migrate(path, &Config::default()).unwrap();
        migration.post_checks(path).unwrap();

        // check that the temporary database directory exists and contains the file with the
        // expected content.
        let temp_db_content_dir = temp_db_path.join("R'lyeh");
        let temp_db_content_file = temp_db_content_dir.join("cthulhu");
        assert!(temp_db_content_file.exists());
        assert_eq!(
            std::fs::read_to_string(temp_db_content_file).unwrap(),
            chant
        );
    }
}