Merge #2: Add a tool to check releases

129e58a Add bitcoincore-rpc to config file (Tobin C. Harding)
11e1fc5 Add a tool to check releases (Tobin C. Harding)

Pull request description:

  Add a tool in Rust that can be used to do some release version checks.

  Currently supports two things:

  - Checking if the latest released version on crates.io is the same as in the config file.

  - Checking that a local crate uses the latest released dependencies (used to check that we have upgraded all deps before releasing a new version).

  Currently the output (colour ticks and crosses in my terminal):
  ```bash
  $ cargo run -- check-latest-dependencies ~/build/github.com/tcharding/rust-bitcoin/master bitcoin
  Checking latest dependencies for:
      crate: bitcoin
      version: "0.32.0-rc1"
      manifest: /home/tobin/build/github.com/tcharding/rust-bitcoin/master/bitcoin/Cargo.toml

      - serde                ✓      1.0.103 latest: 1.0.198
      - base58ck             ✓      0.1.0
      - base64               ✗      0.21.3 latest: 0.22.0
      - bech32               ✓      0.11.0
      - bitcoinconsensus     ✗      0.105.0+25.1 latest: 0.106.0+26.0
      - bitcoin_hashes       ✓      0.14.0
      - hex-conservative     ✓      0.2.0
      - hex_lit              ✓      0.1.1
      - bitcoin-internals    ✓      0.3.0
      - bitcoin-io           ✓      0.1.1 latest: 0.1.2
      - ordered              ✓      0.2.0 latest: 0.2.2
      - secp256k1            ✓      0.29.0
      - bitcoin-units        ✓      0.1.0 latest: 0.1.1
  ```

   I'd like to extend it with all the ideas in  rust-bitcoin/rust-bitcoin#2524 (comment).

  Close: #2524

ACKs for top commit:
  apoelstra:
    ACK 129e58a

Tree-SHA512: d4dfe213a372f832d8464d1e21c6b4f001dcb52256c2086816b45c237aa414f54e490c843208b97546dae591007150a4a7f21d1a0716944af8f04a96998a21fe

Author: apoelstra

releases/Cargo.lock

@@ -0,0 +1,22 @@
+[package]
+name = "releases"
+version = "0.1.0"
+authors = ["Tobin C. Harding <[email protected]>"]
+license = "CC0-1.0"
+repository = "https://github.com/rust-bitcoin/rust-bitcoin-maintainer-tools/"
+description = "Tool for checking various release related things."
+categories = []
+keywords = []
+readme = "README.md"
+edition = "2021"
+rust-version = "1.56.1"
+
+[dependencies]
+anyhow = { version = "1.0.82", default-features = false, features = ["std"] }
+clap = { version = "4.5.4", default-features = false, features = ["std", "color", "help", "usage", "error-context", "suggestions", "derive", "cargo"] }
+crates_io_api = { version = "0.11.0", default-features = false, features = ["rustls"] }
+semver = { version = "1.0.22", default-features = false, features = ["std"] }
+serde_json = { version = "1.0.116", default-features = false, features = [] }
+serde = { version = "1.0.198", features = ["derive"] }
+tokio = { version = "1.37.0", features = ["rt", "macros"] }
+toml = { version = "0.8.12", default-features = false, features = ["display", "parse"] }

releases/Cargo.toml

@@ -0,0 +1,4 @@
+Releases Tool
+=============
+
+This crate provides a tool for doing various release related checks.

releases/README.md

@@ -0,0 +1,116 @@
+{
+    "org": "gihub.com/rust-bitcoin",
+    "latests": [
+        { "package": "bitcoincore-rpc", "version": "0.18.0" },
+        { "package": "bitcoincore-rpc-json", "version": "0.18.0"},
+        { "package": "miniscript", "version": "11.0.0" },
+        { "package": "bitcoin", "version": "0.32.0" },
+        { "package": "base58ck", "version": "0.1.0" },
+        { "package": "bech32", "version": "0.11.0" },
+        { "package": "bitcoin_hashes", "version": "0.14.0" },
+        { "package": "hex-conservative", "version": "0.2.0" },
+        { "package": "hex_lit", "version": "0.1.1" },
+        { "package": "bitcoin-internals", "version": "0.3.0" },
+        { "package": "bitcoin-io", "version": "0.1.2" },
+        { "package": "secp256k1", "version": "0.29.0" },
+        { "package": "units", "version": "0.1.0" },
+        { "package": "ordered", "version": "0.2.2" },
+        { "package": "bitcoinconsensus", "version": "0.106.0+26.0" }
+    ],
+    "releases": [
+        { "package": "bitcoincore-rpc", "version": "0.18.0", "dependencies":
+          [
+              { "package": "bitcoincore-rpc-json", "version": "0.18.0"},
+              { "package": "log", "version": "0.4.5"},
+              { "package": "jsonrpc", "version": "0.14.0"},
+              { "package": "serde", "version": "1.0.156" },
+              { "package": "serde_json", "version": "1.0.96" }
+          ]
+        },
+        { "package": "bitcoincore-rpc", "version": "0.18.0", "dependencies":
+          [
+              { "package": "serde", "version": "1.0.156" },
+              { "package": "serde_json", "version": "1.0.96" },
+              { "package": "bitcoin", "version": "0.31.0" }
+          ]
+        },
+        { "package": "miniscript", "version": "11.0.0", "dependencies":
+          [
+              { "package": "bitcoin", "version": "0.31.0" },
+              { "package": "bitcoin-internals", "version": "0.2.0" },
+              { "package": "bech32", "version": "0.10.0-beta" },
+              { "package": "serde", "version": "1.0.103" }
+          ]
+        },
+        { "package": "bitcoin", "version": "0.32.0-rc1", "dependencies":
+          [
+              { "package": "base58ck", "version": "0.1.0" },
+              { "package": "bech32", "version": "0.11.0" },
+              { "package": "bitcoin_hashes", "version": "0.14.0" },
+              { "package": "hex-conservative", "version": "0.2.0" },
+              { "package": "hex_lit", "version": "0.1.1" },
+              { "package": "bitcoin-internals", "version": "0.3.0" },
+              { "package": "bitcoin-io", "version": "0.1.1" },
+              { "package": "secp256k1", "version": "0.29.0" },
+              { "package": "units", "version": "0.1.0" },
+              { "package": "base64", "version": "0.21.3" },
+              { "package": "ordered", "version": "0.2.0" },
+              { "package": "bitcoinconsensus", "version": "0.105.0" },
+              { "package": "serde", "version": "1.0.103" }
+          ]
+        },
+        { "package": "bitcoin", "version": "0.31.2", "dependencies":
+          [
+              { "package": "bitcoin-internals", "version": "0.2.0" },
+              { "package": "hex-conservative", "version": "0.1.1" },
+              { "package": "bech32", "version": "0.10.0-beta" },
+              { "package": "bitcoin_hashes", "version": "0.13.0" },
+              { "package": "secp256k1", "version": "0.28.0" },
+              { "package": "bitcoinconsensus", "version": "0.20.2-0.5.0" },
+              { "package": "hex_lit", "version": "0.1.1" },
+              { "package": "base64", "version": "0.21.3" },
+              { "package": "core2", "version": "0.3.2" },
+              { "package": "serde", "version": "1.0.103" }
+          ]
+        },
+        { "package": "base58ck", "version": "0.1.0", "dependencies":
+          [
+            { "package": "bitcoin_hashes", "version": "0.14.0" },
+            { "package": "bitcoin-internals", "version": "0.3.0" }
+          ]
+        },
+        { "package": "bitcoin_hashes", "version": "0.13.0", "dependencies":
+          [
+              { "package": "bitcoin-internals", "version": "0.2.0" },
+              { "package": "hex-conservative", "version": "0.1.1" },
+              { "package": "schemars", "version": "0.8.3" },
+              { "package": "serde", "version": "1.0.0" },
+              { "package": "core2", "version": "0.3.2" }
+          ]
+        },
+        { "package": "bitcoin-internals", "version": "0.2.0", "dependencies":
+          [
+              { "package": "serde", "version": "1.0.103" }
+          ]
+        },
+        { "package": "bech32", "version": "0.10.0-beta", "dependencies": [] },
+        { "package": "secp256k1", "version": "0.28.0", "dependencies":
+          [
+              { "package": "secp256k1-sys", "version": "0.9.0" },
+              { "package": "bitcoin_hashes", "version": "0.13.0" },
+              { "package": "rand", "version": "0.8.0" }
+          ]
+        },
+        { "package": "secp256k1-sys", "version": "0.9.0", "dependencies": [] },
+        { "package": "hex-conservative", "version": "0.1.1", "dependencies":
+          [
+              { "package": "core2", "version": "0.3.2" }
+          ]
+        },
+        { "package": "bitcoinconsensus", "version": "0.20.2-0.5.0", "dependencies":
+          [
+              { "package": "libc", "version": "0.2.0" }
+          ]
+        }
+    ]
+}

releases/releases.json

@@ -0,0 +1,77 @@
+ignore = []
+hard_tabs = false
+tab_spaces = 4
+newline_style = "Auto"
+indent_style = "Block"
+
+max_width = 100 # This is number of characters.
+# `use_small_heuristics` is ignored if the granular width config values are explicitly set.
+use_small_heuristics = "Max"    # "Max" == All granular width settings same as `max_width`.
+# # Granular width configuration settings. These are percentages of `max_width`.
+# fn_call_width = 60
+# attr_fn_like_width = 70
+# struct_lit_width = 18
+# struct_variant_width = 35
+# array_width = 60
+# chain_width = 60
+# single_line_if_else_max_width = 50
+
+wrap_comments = false
+format_code_in_doc_comments = false
+comment_width = 100             # Default 80
+normalize_comments = false
+normalize_doc_attributes = false
+format_strings = false
+format_macro_matchers = false
+format_macro_bodies = true
+hex_literal_case = "Preserve"
+empty_item_single_line = true
+struct_lit_single_line = true
+fn_single_line = true           # Default false
+where_single_line = false
+imports_indent = "Block"
+imports_layout = "Mixed"
+imports_granularity = "Module"     # Default "Preserve"
+group_imports = "StdExternalCrate" # Default "Preserve"
+reorder_imports = true
+reorder_modules = true
+reorder_impl_items = false
+type_punctuation_density = "Wide"
+space_before_colon = false
+space_after_colon = true
+spaces_around_ranges = false
+binop_separator = "Front"
+remove_nested_parens = true
+combine_control_expr = true
+overflow_delimited_expr = false
+struct_field_align_threshold = 0
+enum_discrim_align_threshold = 0
+match_arm_blocks = false        # Default true
+match_arm_leading_pipes = "Never"
+force_multiline_blocks = false
+fn_params_layout = "Tall"
+brace_style = "SameLineWhere"
+control_brace_style = "AlwaysSameLine"
+trailing_semicolon = true
+trailing_comma = "Vertical"
+match_block_trailing_comma = false
+blank_lines_upper_bound = 1
+blank_lines_lower_bound = 0
+edition = "2021"
+version = "One"
+inline_attribute_width = 0
+format_generated_files = true
+merge_derives = true
+use_try_shorthand = false
+use_field_init_shorthand = false
+force_explicit_abi = true
+condense_wildcard_suffixes = false
+color = "Auto"
+unstable_features = false
+disable_all_formatting = false
+skip_children = false
+hide_parse_errors = false
+error_on_line_overflow = false
+error_on_unformatted = false
+emit_mode = "Files"
+make_backup = false

releases/rustfmt.toml

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Interact with the crates.io API.
+
+pub fn latest_release(package: &str) -> Release { todo!() }

releases/src/api.rs

@@ -0,0 +1,39 @@
+//! Types that represent the JSON schema and provide deserialization.
+//!
+//! We deserialize to Rust std types then convert to more strictly typed types manually.
+
+#![allow(dead_code)] // This is just the JSON schemar, all fields exist.
+
+use serde::Deserialize;
+
+/// The `releases.json` config file.
+#[derive(Debug, Deserialize)]
+pub struct Config {
+    /// The github organisation this config file relates to.
+    pub org: String,
+    /// List of the latest releases.
+    pub latests: Vec<CrateVersion>,
+    /// List of all releases we run checks against.
+    pub releases: Vec<CrateNode>,
+}
+
+/// As specific version of a crate.
+#[derive(Debug, Deserialize)]
+pub struct CrateVersion {
+    /// The crate's package name on crates.io
+    pub package: String,
+    /// The dependencies semantic version number.
+    pub version: String,
+}
+
+/// A version of one of the crates along with a list of its dependencies (and their versions) - used
+/// to make a dependency graph.
+#[derive(Debug, Deserialize)]
+pub struct CrateNode {
+    /// The crate's package name on crates.io
+    pub package: String,
+    /// The release's semantic version number.
+    pub version: String,
+    /// List of this releases dependencies.
+    pub dependencies: Vec<CrateVersion>,
+}

releases/src/json.rs

@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Tool to check various release related things.
+
+// Coding conventions.
+#![warn(missing_docs)]
+
+use std::fmt;
+
+use anyhow::bail;
+use semver::Version;
+
+pub mod json;
+
+/// The state of the rust-bitcoin org that this tool aims to run checks on.
+#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct Config {
+    /// List of the latest releases.
+    pub latests: Vec<CrateVersion>,
+    /// The releases we want to check.
+    pub releases: Vec<CrateNode>,
+}
+
+impl Config {
+    /// Returns the latest release of the given crate.
+    pub fn latest(&self, package: &str) -> anyhow::Result<Version> {
+        let mut want = None;
+        for latest in self.latests.iter() {
+            if latest.package == package {
+                want = Some(latest.version.clone());
+            }
+        }
+        if want.is_none() {
+            bail!("package {} is not listed in latest section of config file", package);
+        }
+
+        let mut found = Version::parse("0.0.0").expect("valid zero version");
+        let mut release = None;
+        for r in self.releases.iter() {
+            if r.package == package && r.version > found {
+                found = r.version.clone();
+                release = Some(r);
+            }
+        }
+        match release {
+            Some(r) => {
+                if r.version != want.expect("checked above") {
+                    bail!("the latest version in the releases section for {} does not match the verison in the latest section", package);
+                }
+                Ok(r.version.clone())
+            }
+            None => bail!("we don't have a release in the config file for {}", package),
+        }
+    }
+}
+
+impl TryFrom<json::Config> for Config {
+    type Error = semver::Error;
+
+    fn try_from(json: json::Config) -> Result<Self, Self::Error> {
+        let latests: Result<Vec<_>, _> = json.latests.into_iter().map(TryFrom::try_from).collect();
+        let releases: Result<Vec<_>, _> =
+            json.releases.into_iter().map(TryFrom::try_from).collect();
+        Ok(Self { latests: latests?, releases: releases? })
+    }
+}
+
+/// As specific version of a crate.
+#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct CrateVersion {
+    /// The crate's package name on crates.io
+    pub package: String,
+    /// The dependencies semantic version number.
+    pub version: Version,
+}
+
+impl TryFrom<json::CrateVersion> for CrateVersion {
+    type Error = semver::Error;
+
+    fn try_from(json: json::CrateVersion) -> Result<Self, Self::Error> {
+        Ok(Self { package: json.package, version: Version::parse(&json.version)? })
+    }
+}
+
+/// A version of one of the crates that lives in the github.com/rust-bitcoin org.
+#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct CrateNode {
+    /// The crate this release is for.
+    pub package: String,
+    /// The release's semantic version number.
+    pub version: Version,
+    /// List of this releases dependencies.
+    pub dependencies: Vec<CrateVersion>,
+}
+
+impl fmt::Display for CrateNode {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{} {}", self.package, self.version)
+    }
+}
+
+impl TryFrom<json::CrateNode> for CrateNode {
+    type Error = semver::Error;
+
+    fn try_from(json: json::CrateNode) -> Result<Self, Self::Error> {
+        let mut dependencies = vec![];
+        for d in json.dependencies {
+            let converted = CrateVersion::try_from(d)?;
+            dependencies.push(converted);
+        }
+
+        Ok(Self { package: json.package, version: Version::parse(&json.version)?, dependencies })
+    }
+}