Merge pull request #130 from michaelwoerister/better-version-checks

Add a CI check that all crates in the workspace have a consistent version

Author: wesleywiser

.gitignore

@@ -11,3 +11,11 @@ Cargo.lock
 
 # Directories created by integration tests
 test-tmp/
+
+# Some common files from IDEs/editors
+*.sublime-project
+*.sublime-workspace
+
+# Data files generated by Linux perf
+perf.data
+perf.data.old

.travis.yml

@@ -10,6 +10,7 @@ env:
   - CARGO_INCREMENTAL=0
 install: skip
 script:
+  - cargo run --bin version_checker || exit 1
   - cargo check --verbose --target powerpc64-unknown-linux-gnu --lib --bins --tests || exit 1
   - cargo build --verbose --all || exit 1
   - cargo test --verbose --all

Cargo.toml

@@ -8,4 +8,5 @@ members = [
     "mmview",
     "stack_collapse",
     "summarize",
+    "version_checker",
 ]

analyzeme/src/profiling_data.rs

@@ -131,7 +131,7 @@ impl ProfilingData {
 
         LightweightEvent {
             data: self,
-            event_index: event_index,
+            event_index,
             timestamp,
             thread_id: raw_event.thread_id,
         }

measureme/src/stringtable.rs

@@ -285,7 +285,7 @@ impl<S: SerializationSink> StringTableBuilder<S> {
     ) where
         I: Iterator<Item = StringId> + ExactSizeIterator,
     {
-        // TODO: Index data encoding could have special bulk mode that assigns
+        // TODO: Index data encoding could have a special bulk mode that assigns
         //       multiple StringIds to the same addr, so we don't have to repeat
         //       the `concrete_id` over and over.
 

version_checker/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "version_checker"
+version = "0.7.1"
+authors = ["Michael Woerister <michaelwoerister@posteo>"]
+edition = "2018"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+regex = "1"
+glob = "0.3.0"

version_checker/src/main.rs

@@ -0,0 +1,63 @@
+// This is a small tool for making sure that we keep versions between all crates
+// in the workspace consistent. It just panics if it finds an error and is
+// supposed to be run as part of CI.
+
+use glob::glob;
+use regex::Regex;
+use std::collections::BTreeMap;
+use std::path::{Path, PathBuf};
+
+fn main() {
+    eprint!(
+        "Checking Cargo workspace \"{}\" for crate version consistency ... ",
+        Path::new(".").canonicalize().unwrap().display()
+    );
+
+    let workspace_cargo_toml_txt = std::fs::read_to_string("Cargo.toml").unwrap();
+
+    if !workspace_cargo_toml_txt.trim().starts_with("[workspace]") {
+        panic!(
+            "Could not find workspace Cargo.toml at {}.\n\
+                This tool has to be executed in the top-level directory \
+                of the Cargo workspace.",
+            Path::new("Cargo.toml").canonicalize().unwrap().display()
+        );
+    }
+
+    let mut versions: BTreeMap<PathBuf, String> = BTreeMap::new();
+
+    let version_regex = Regex::new("version\\s*=\\s*\"(\\d+\\.\\d+\\.\\d+)\"").unwrap();
+
+    for entry in glob("./*/Cargo.toml").expect("Failed to read glob pattern") {
+        let cargo_toml_path = entry.unwrap();
+        let cargo_toml_txt = std::fs::read_to_string(&cargo_toml_path).unwrap();
+
+        for line in cargo_toml_txt.lines() {
+            if let Some(caps) = version_regex.captures(line) {
+                let version = caps[1].to_string();
+                versions.insert(cargo_toml_path.clone(), version);
+                break;
+            }
+        }
+
+        if !versions.contains_key(&cargo_toml_path) {
+            panic!(
+                "Could not find `version` field in {}",
+                cargo_toml_path.display()
+            );
+        }
+    }
+
+    let reference_version = versions.values().next().unwrap();
+
+    if !versions.values().all(|v| v == reference_version) {
+        eprintln!("Crate versions found:");
+        for (cargo_toml_path, version) in &versions {
+            eprintln!("  {} = {}", cargo_toml_path.display(), version);
+        }
+
+        panic!("Not all crate versions are the same, please keep them in sync!");
+    }
+
+    eprintln!("check passed");
+}