From 2116664427038ccddc248145ec891291627021c3 Mon Sep 17 00:00:00 2001 From: Mathieu Barbin Date: Mon, 30 Sep 2024 15:05:03 +0200 Subject: [PATCH] Add an admin command to compare 2 package versions Signed-off-by: Mathieu Barbin --- doc/man/opam-admin-topics.inc | 11 +++++ master_changes.md | 1 + src/client/opamAdminCommand.ml | 67 ++++++++++++++++++++++++++++ tests/reftests/compare-versions.test | 21 +++++++++ tests/reftests/dune.inc | 18 ++++++++ 5 files changed, 118 insertions(+) create mode 100644 tests/reftests/compare-versions.test diff --git a/doc/man/opam-admin-topics.inc b/doc/man/opam-admin-topics.inc index c2618ecb6cf..ffbb4aed863 100644 --- a/doc/man/opam-admin-topics.inc +++ b/doc/man/opam-admin-topics.inc @@ -60,6 +60,16 @@ (diff opam-admin-list.err %{dep:opam-admin-list.0}))) (package opam)) +(rule + (with-stdout-to opam-admin-compare-versions.0 (echo ""))) +(rule + (targets opam-admin-compare-versions.1 opam-admin-compare-versions.err) + (deps using-built-opam) + (action (progn (with-stderr-to opam-admin-compare-versions.err + (with-stdout-to opam-admin-compare-versions.1 (run %{bin:opam} admin compare-versions --help=groff))) + (diff opam-admin-compare-versions.err %{dep:opam-admin-compare-versions.0}))) + (package opam)) + (rule (with-stdout-to opam-admin-check.0 (echo ""))) (rule @@ -130,6 +140,7 @@ opam-admin-add-constraint.1 opam-admin-filter.1 opam-admin-list.1 + opam-admin-compare-versions.1 opam-admin-check.1 opam-admin-lint.1 opam-admin-upgrade.1 diff --git a/master_changes.md b/master_changes.md index 313b5b7dd60..4db84988f4d 100644 --- a/master_changes.md +++ b/master_changes.md @@ -14,6 +14,7 @@ users) * Bump the version of opam to 2.4.0~alpha1~dev [#6204 @kit-ty-kate] ## Global CLI + * ◈ Add `opam admin compare-versions` to compare package versions for sanity checks [#6197 @mbarbin] ## Plugins diff --git a/src/client/opamAdminCommand.ml b/src/client/opamAdminCommand.ml index 38954d1c6b1..cbd6d8e4812 100644 --- a/src/client/opamAdminCommand.ml +++ b/src/client/opamAdminCommand.ml @@ -830,6 +830,72 @@ let check_command cli = Term.(const cmd $ global_options cli $ ignore_test_arg $ print_short_arg $ installability_arg $ cycles_arg $ obsolete_arg) +let compare_versions_command_doc = "Compare 2 package versions" +let compare_versions_command cli = + let operator : OpamFormula.relop option Term.t = + let make_flag (relop : OpamFormula.relop) = + let flag_name = + match relop with + | `Eq -> "eq" + | `Neq -> "neq" + | `Geq -> "geq" + | `Gt -> "gt" + | `Leq -> "leq" + | `Lt -> "lt" + in + let doc = Printf.sprintf "assert V0 %s V1" (OpamFormula.string_of_relop relop) in + OpamArg.(cli_from cli2_4), Some relop, [ flag_name ], doc + in + OpamArg.mk_vflag ~cli None (List.map make_flag OpamFormula.all_relop) + in + let version_arg n = + let doc = + Arg.info + ~docv:(Printf.sprintf "V%d" n) + ~doc:"Package version to compare" [] + in + Arg.(required & pos n (some OpamArg.package_version) None & doc) + in + let command = "compare-versions" in + let doc = compare_versions_command_doc in + let man = [ + `S Manpage.s_description; + `P "This command compares 2 package versions. By default it outputs 'V0 OP V1' \ + to the console with OP in {<,>,=} such that the equation holds. When an operator \ + is supplied, the output is suppressed and the result of the comparison is checked \ + againts the provided operator: the command exits 0 if the comparison holds, and 1 \ + otherwise. For example:"; + `Pre "\n\ + \\$ opam admin compare-versions 0.0.9 0.0.10\n\ + 0.0.9 < 0.0.10\n\ + \n\ + \\$ opam admin compare-versions 0.0.9 --lt 0.0.10\n\ + [0]\n\ + \n\ + \\$ opam admin compare-versions 0.0.9 --eq 0.0.10\n\ + [1]"; + `S Manpage.s_arguments; + `S Manpage.s_options; + ] + in + let cmd global_options v0 v1 operator () = + OpamArg.apply_global_options cli global_options; + match operator with + | None -> + let result = OpamPackage.Version.compare v0 v1 in + OpamConsole.formatted_msg "%s %s %s\n" + (OpamPackage.Version.to_string v0) + (if result < 0 then "<" else if result = 0 then "=" else ">") + (OpamPackage.Version.to_string v1) + | Some operator -> + OpamStd.Sys.exit_because + (if OpamFormula.eval_relop operator v0 v1 + then `Success + else `False) + in + OpamArg.mk_command ~cli OpamArg.cli_original command ~doc ~man + Term.(const cmd $ global_options cli $ version_arg 0 $ version_arg 1 $ operator) + let pattern_list_arg = OpamArg.arg_list "PATTERNS" "Package patterns with globs. matching against $(b,NAME) or \ @@ -1227,6 +1293,7 @@ let admin_subcommands cli = upgrade_command cli; lint_command cli; check_command cli; + compare_versions_command cli; list_command cli; filter_command cli; add_constraint_command cli; diff --git a/tests/reftests/compare-versions.test b/tests/reftests/compare-versions.test new file mode 100644 index 00000000000..ac41e4e689d --- /dev/null +++ b/tests/reftests/compare-versions.test @@ -0,0 +1,21 @@ +N0REP0 +### opam admin compare-versions 0.0.9 0.0.10 +0.0.9 < 0.0.10 +### opam admin compare-versions 1.2.3 1.2.3~preview +1.2.3 > 1.2.3~preview +### opam admin compare-versions 1.2.3 1.2.3-option +1.2.3 < 1.2.3-option +### opam admin compare-versions 0.1.0 0.01.0 +0.1.0 = 0.01.0 +### opam admin compare-versions 0.2.2 0.2.0 +0.2.2 > 0.2.0 +### opam admin compare-versions 0.0.9 --lt 0.0.10 +### opam admin compare-versions 1.2.3 --lt 1.2.3~preview +# Return code 1 # +### opam admin compare-versions 0.1.0 --eq 0.01.0 +### opam admin compare-versions 0.0.9 --eq 0.0.10 +# Return code 1 # +### opam admin compare-versions 0.1.0 --le 0.1.0 +### opam admin compare-versions 0.0.9 --le 0.0.10 +### opam admin compare-versions 0.2.2 --le 0.2.1 +# Return code 1 # diff --git a/tests/reftests/dune.inc b/tests/reftests/dune.inc index ce89cec8454..b58af2dc12a 100644 --- a/tests/reftests/dune.inc +++ b/tests/reftests/dune.inc @@ -188,6 +188,24 @@ %{targets} (run ./run.exe %{exe:../../src/client/opamMain.exe.exe} %{dep:cli-versioning.test} %{read-lines:testing-env})))) +(rule + (alias reftest-compare-versions) + (action + (diff compare-versions.test compare-versions.out))) + +(alias + (name reftest) + (deps (alias reftest-compare-versions))) + +(rule + (targets compare-versions.out) + (deps root-N0REP0) + (package opam) + (action + (with-stdout-to + %{targets} + (run ./run.exe %{exe:../../src/client/opamMain.exe.exe} %{dep:compare-versions.test} %{read-lines:testing-env})))) + (rule (alias reftest-config) (enabled_if (and (or (<> %{env:TESTALL=1} 0) (= %{env:TESTN0REP0=0} 1))))