Merge pull request #182 from DeterminateSystems/sort-ref-status

Sort keys in ref-statuses.json

Author: lucperkins

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "flake-checker"
-version = "0.2.6"
+version = "0.2.7"
 edition = "2021"
 
 [workspace]

Cargo.toml

@@ -26,16 +26,16 @@ But you can also use Nix Flake Checker [in CI](#the-flake-checker-action).
 ## Supported branches
 
 At any given time, [Nixpkgs] has a bounded set of branches that are considered _supported_.
-The current list:
+The current list, with their statuses:
 
-- `nixos-23.11`
-- `nixos-23.11-small`
-- `nixos-24.05`
-- `nixos-24.05-small`
+- `nixos-24.11`
+- `nixos-24.11-small`
+- `nixos-25.05`
+- `nixos-25.05-small`
 - `nixos-unstable`
 - `nixos-unstable-small`
-- `nixpkgs-23.11-darwin`
-- `nixpkgs-24.05-darwin`
+- `nixpkgs-24.11-darwin`
+- `nixpkgs-25.05-darwin`
 - `nixpkgs-unstable`
 
 ## Parameters

README.md

@@ -1,14 +1,14 @@
 {
-  "nixpkgs-25.05-darwin": "stable",
   "nixos-24.05": "unmaintained",
-  "nixos-unstable-small": "rolling",
-  "nixos-24.11": "deprecated",
-  "nixos-25.05-small": "stable",
   "nixos-24.05-small": "unmaintained",
+  "nixos-24.11": "deprecated",
   "nixos-24.11-small": "deprecated",
-  "nixpkgs-24.11-darwin": "deprecated",
-  "nixos-unstable": "rolling",
   "nixos-25.05": "stable",
-  "nixpkgs-unstable": "rolling",
-  "nixpkgs-24.05-darwin": "unmaintained"
+  "nixos-25.05-small": "stable",
+  "nixos-unstable": "rolling",
+  "nixos-unstable-small": "rolling",
+  "nixpkgs-24.05-darwin": "unmaintained",
+  "nixpkgs-24.11-darwin": "deprecated",
+  "nixpkgs-25.05-darwin": "stable",
+  "nixpkgs-unstable": "rolling"
 }

ref-statuses.json

@@ -1,7 +1,7 @@
 use cel_interpreter::{Context, Program, Value};
 use parse_flake_lock::{FlakeLock, Node};
 
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 
 use crate::{
     error::FlakeCheckerError,
@@ -19,11 +19,15 @@ pub(super) fn evaluate_condition(
     flake_lock: &FlakeLock,
     nixpkgs_keys: &[String],
     condition: &str,
-    ref_statuses: HashMap<String, String>,
+    ref_statuses: BTreeMap<String, String>,
     supported_refs: Vec<String>,
 ) -> Result<Vec<Issue>, FlakeCheckerError> {
     let mut issues: Vec<Issue> = vec![];
     let mut ctx = Context::default();
+
+    let ref_statuses = ref_statuses
+        .into_iter()
+        .collect::<HashMap<String, String>>();
     ctx.add_variable_from_value(KEY_REF_STATUSES, ref_statuses);
     ctx.add_variable_from_value(KEY_SUPPORTED_REFS, supported_refs);
 

src/condition.rs

@@ -1,6 +1,6 @@
 #![allow(dead_code)]
 
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 use crate::issue::{Disallowed, Issue, IssueKind, NonUpstream, Outdated};
 use crate::FlakeCheckerError;
@@ -33,8 +33,8 @@ impl Default for FlakeCheckConfig {
 pub(super) fn nixpkgs_deps(
     flake_lock: &FlakeLock,
     keys: &[String],
-) -> Result<HashMap<String, Node>, FlakeCheckerError> {
-    let mut deps: HashMap<String, Node> = HashMap::new();
+) -> Result<BTreeMap<String, Node>, FlakeCheckerError> {
+    let mut deps: BTreeMap<String, Node> = BTreeMap::new();
 
     for (ref key, node) in flake_lock.root.clone() {
         match &node {
@@ -144,7 +144,7 @@ pub(super) fn num_days_old(timestamp: i64) -> i64 {
 
 #[cfg(test)]
 mod test {
-    use std::collections::HashMap;
+    use std::collections::BTreeMap;
     use std::path::PathBuf;
 
     use crate::{
@@ -171,7 +171,7 @@ mod test {
             ),
         ];
 
-        let ref_statuses: HashMap<String, String> =
+        let ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
         let supported_refs = supported_refs(ref_statuses.clone());
         let path = PathBuf::from("tests/flake.cel.0.lock");
@@ -204,7 +204,7 @@ mod test {
 
     #[test]
     fn clean_flake_locks() {
-        let ref_statuses: HashMap<String, String> =
+        let ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
         let allowed_refs = supported_refs(ref_statuses);
         for n in 0..=7 {
@@ -225,7 +225,7 @@ mod test {
 
     #[test]
     fn dirty_flake_locks() {
-        let ref_statuses: HashMap<String, String> =
+        let ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
         let allowed_refs = supported_refs(ref_statuses);
         let cases: Vec<(&str, Vec<Issue>)> = vec![
@@ -280,7 +280,7 @@ mod test {
 
     #[test]
     fn explicit_nixpkgs_keys() {
-        let ref_statuses: HashMap<String, String> =
+        let ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
         let allowed_refs = supported_refs(ref_statuses);
         let cases: Vec<(&str, Vec<String>, Vec<Issue>)> = vec![(
@@ -309,7 +309,7 @@ mod test {
 
     #[test]
     fn missing_nixpkgs_keys() {
-        let ref_statuses: HashMap<String, String> =
+        let ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
         let allowed_refs = supported_refs(ref_statuses);
         let cases: Vec<(&str, Vec<String>, String)> = vec![(

src/flake.rs

@@ -7,7 +7,7 @@ mod summary;
 #[cfg(feature = "ref-statuses")]
 mod ref_statuses;
 
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use std::path::PathBuf;
 use std::process::ExitCode;
 
@@ -97,11 +97,11 @@ struct Cli {
 }
 
 #[cfg(not(feature = "ref-statuses"))]
-pub(crate) fn supported_refs(ref_statuses: HashMap<String, String>) -> Vec<String> {
+pub(crate) fn supported_refs(ref_statuses: BTreeMap<String, String>) -> Vec<String> {
     let mut return_value: Vec<String> = ref_statuses
         .iter()
         .filter_map(|(channel, status)| {
-            if *status != "unmaintained" && *status != "beta" {
+            if ["rolling", "stable", "deprecated"].contains(&status.as_str()) {
                 Some(channel.clone())
             } else {
                 None
@@ -120,7 +120,7 @@ async fn main() -> Result<ExitCode, FlakeCheckerError> {
         .with(EnvFilter::from_default_env())
         .init();
 
-    let ref_statuses: HashMap<String, String> =
+    let ref_statuses: BTreeMap<String, String> =
         serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
 
     let Cli {
@@ -279,7 +279,7 @@ fn main() -> Result<ExitCode, FlakeCheckerError> {
     }
 
     if check_ref_statuses {
-        let mut ref_statuses: HashMap<String, String> =
+        let mut ref_statuses: BTreeMap<String, String> =
             serde_json::from_str(include_str!("../ref-statuses.json")).unwrap();
 
         match ref_statuses::check_ref_statuses(ref_statuses) {

src/main.rs

@@ -2,7 +2,7 @@ use crate::error::FlakeCheckerError;
 
 use serde::Deserialize;
 
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 const ALLOWED_REFS_URL: &str = "https://prometheus.nixos.org/api/v1/query?query=channel_revision";
 
@@ -28,13 +28,13 @@ struct Metric {
 }
 
 pub(crate) fn check_ref_statuses(
-    ref_statuses: HashMap<String, String>,
+    ref_statuses: BTreeMap<String, String>,
 ) -> Result<bool, FlakeCheckerError> {
     Ok(fetch_ref_statuses()? == ref_statuses)
 }
 
-pub(crate) fn fetch_ref_statuses() -> Result<HashMap<String, String>, FlakeCheckerError> {
-    let mut officially_supported: HashMap<String, String> =
+pub(crate) fn fetch_ref_statuses() -> Result<BTreeMap<String, String>, FlakeCheckerError> {
+    let mut officially_supported: BTreeMap<String, String> =
         reqwest::blocking::get(ALLOWED_REFS_URL)?
             .json::<Response>()?
             .data

src/ref_statuses.rs

@@ -52,7 +52,7 @@
       },
       "original": {
         "owner": "nixos",
-        "ref": "nixos-24.11",
+        "ref": "nixos-25.05",
         "repo": "nixpkgs",
         "type": "github"
       }