152 lines
4.3 KiB
Rust
152 lines
4.3 KiB
Rust
// Copyright 2015, 2016 Ethcore (UK) Ltd.
|
|
// This file is part of Parity.
|
|
|
|
// Parity is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Parity 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 General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Tests for migrations.
|
|
//! A random temp directory is created. A database is created within it, and migrations
|
|
//! are performed in temp sub-directories.
|
|
|
|
use common::*;
|
|
use migration::{Config, SimpleMigration, Manager};
|
|
use kvdb::{Database, DBTransaction};
|
|
|
|
use devtools::RandomTempPath;
|
|
use std::path::PathBuf;
|
|
|
|
fn db_path(path: &Path) -> PathBuf {
|
|
let mut p = path.to_owned();
|
|
p.push("db");
|
|
p
|
|
}
|
|
|
|
// initialize a database at the given directory with the given values.
|
|
fn make_db(path: &Path, pairs: BTreeMap<Vec<u8>, Vec<u8>>) {
|
|
let db = Database::open_default(path.to_str().unwrap()).expect("failed to open temp database");
|
|
{
|
|
let transaction = DBTransaction::new();
|
|
for (k, v) in pairs {
|
|
transaction.put(&k, &v).expect("failed to add pair to transaction");
|
|
}
|
|
|
|
db.write(transaction).expect("failed to write db transaction");
|
|
}
|
|
}
|
|
|
|
// helper for verifying a migrated database.
|
|
fn verify_migration(path: &Path, pairs: BTreeMap<Vec<u8>, Vec<u8>>) {
|
|
let db = Database::open_default(path.to_str().unwrap()).unwrap();
|
|
|
|
for (k, v) in pairs {
|
|
let x = db.get(&k).unwrap().unwrap();
|
|
|
|
assert_eq!(&x[..], &v[..]);
|
|
}
|
|
}
|
|
|
|
struct Migration0;
|
|
|
|
impl SimpleMigration for Migration0 {
|
|
fn version(&self) -> u32 {
|
|
1
|
|
}
|
|
|
|
fn simple_migrate(&self, key: Vec<u8>, value: Vec<u8>) -> Option<(Vec<u8>, Vec<u8>)> {
|
|
let mut key = key;
|
|
key.push(0x11);
|
|
let mut value = value;
|
|
value.push(0x22);
|
|
Some((key, value))
|
|
}
|
|
}
|
|
|
|
struct Migration1;
|
|
|
|
impl SimpleMigration for Migration1 {
|
|
fn version(&self) -> u32 {
|
|
2
|
|
}
|
|
|
|
fn simple_migrate(&self, key: Vec<u8>, _value: Vec<u8>) -> Option<(Vec<u8>, Vec<u8>)> {
|
|
Some((key, vec![]))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn one_simple_migration() {
|
|
let dir = RandomTempPath::create_dir();
|
|
let db_path = db_path(dir.as_path());
|
|
let mut manager = Manager::new(Config::default());
|
|
make_db(&db_path, map![vec![] => vec![], vec![1] => vec![1]]);
|
|
let expected = map![vec![0x11] => vec![0x22], vec![1, 0x11] => vec![1, 0x22]];
|
|
|
|
manager.add_migration(Migration0).unwrap();
|
|
let end_path = manager.execute(&db_path, 0).unwrap();
|
|
|
|
verify_migration(&end_path, expected);
|
|
}
|
|
|
|
#[test]
|
|
#[should_panic]
|
|
fn no_migration_needed() {
|
|
let dir = RandomTempPath::create_dir();
|
|
let db_path = db_path(dir.as_path());
|
|
let mut manager = Manager::new(Config::default());
|
|
make_db(&db_path, map![vec![] => vec![], vec![1] => vec![1]]);
|
|
|
|
manager.add_migration(Migration0).unwrap();
|
|
manager.execute(&db_path, 1).unwrap();
|
|
}
|
|
|
|
#[test]
|
|
fn multiple_migrations() {
|
|
let dir = RandomTempPath::create_dir();
|
|
let db_path = db_path(dir.as_path());
|
|
let mut manager = Manager::new(Config::default());
|
|
make_db(&db_path, map![vec![] => vec![], vec![1] => vec![1]]);
|
|
let expected = map![vec![0x11] => vec![], vec![1, 0x11] => vec![]];
|
|
|
|
manager.add_migration(Migration0).unwrap();
|
|
manager.add_migration(Migration1).unwrap();
|
|
let end_path = manager.execute(&db_path, 0).unwrap();
|
|
|
|
verify_migration(&end_path, expected);
|
|
}
|
|
|
|
#[test]
|
|
fn second_migration() {
|
|
let dir = RandomTempPath::create_dir();
|
|
let db_path = db_path(dir.as_path());
|
|
let mut manager = Manager::new(Config::default());
|
|
make_db(&db_path, map![vec![] => vec![], vec![1] => vec![1]]);
|
|
let expected = map![vec![] => vec![], vec![1] => vec![]];
|
|
|
|
manager.add_migration(Migration0).unwrap();
|
|
manager.add_migration(Migration1).unwrap();
|
|
let end_path = manager.execute(&db_path, 1).unwrap();
|
|
|
|
verify_migration(&end_path, expected);
|
|
}
|
|
|
|
#[test]
|
|
fn is_migration_needed() {
|
|
let mut manager = Manager::new(Config::default());
|
|
manager.add_migration(Migration0).unwrap();
|
|
manager.add_migration(Migration1).unwrap();
|
|
|
|
assert!(manager.is_needed(0));
|
|
assert!(manager.is_needed(1));
|
|
assert!(!manager.is_needed(2));
|
|
}
|