Skip to content

Minor fixes to opam-ci-check-lint #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 3, 2025
+37 −31
Merged

Minor fixes to opam-ci-check-lint #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a751e24
Add docv for couple of positional arguments
punchagan Aug 21, 2025
89449c7
Fix typo in variable name
punchagan Aug 21, 2025
c437d4d
Remove extra word in error message
punchagan Oct 3, 2025
eabbd44
Work around UTF8 string length calculation differences
punchagan Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions opam-ci-check/bin/main.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ let use_dune_term =
Arg.value (Arg.flag info)

let pkg_term =
let info = Arg.info [] ~doc:"Package name + version" in
let info = Arg.info [] ~doc:"Package <name.version>" ~docv:"pkg" in
Arg.required (Arg.pos 0 (Arg.some Arg.string) None info)

let split_on_first c s =
Expand Down Expand Up @@ -286,7 +286,7 @@ let package_specs_term =
Error
(`Msg
(Printf.sprintf
"%s is an not a valid attribute. Only [src=<path>] or \
"%s is not a valid attribute. Only [src=<path>] or \
[new=<true|false>] allowed"
s))
in
Expand All @@ -302,14 +302,15 @@ let package_specs_term =
in
let info =
Arg.info []
~docv:"pkg_spec"
~doc:
"List of package specifications (format: \
<name.version>[:src=<path>][,new=<true|false>]). If [src] is not \
specified, the sources are downloaded from the source URL. If [new] \
is not specified, it is inferred from the opam repository."
in
let+ pgk_spec_data = Arg.value (Arg.pos_all package_spec_conv [] info) in
pgk_spec_data
let+ pkg_spec_data = Arg.value (Arg.pos_all package_spec_conv [] info) in
pkg_spec_data
|> List.map (fun (pkg, specs) ->
let src =
List.find_map (function `Src s -> Some s | _ -> None) specs
Expand Down
59 changes: 32 additions & 27 deletions opam-ci-check/test/lint.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Test for an invalid package spec

$ opam-ci-check lint -r . '=-~!:new=true'
opam-ci-check: invalid value '=-~!', expected opam package spec in the form
<name.version>
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
opam-ci-check: pkg_spec… arguments: invalid value '=-~!', expected opam
package spec in the form <name.version>
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]

Expand All @@ -14,54 +14,59 @@ Test for an invalid attributes
Test for invalid attributes that are properly formed

$ opam-ci-check lint -r . 'foo.0.1.0:bar=baz'
opam-ci-check: invalid element in list ('bar=baz'): bar=baz is an not a valid
attribute. Only [src=<path>] or [new=<true|false>] allowed
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
opam-ci-check: pkg_spec… arguments: invalid element in list ('bar=baz'):
bar=baz is not a valid attribute. Only [src=<path>] or
[new=<true|false>] allowed
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]

Test for an invalid values to a valid key

$ opam-ci-check lint -r . 'foo.0.1.0:new=invalid'
opam-ci-check: invalid element in list ('new=invalid'): invalid must be
[true] or [false]
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]
# NOTE: We get rid of the line breaks in the output to work around
# differences in UTF-8 length calculation between OCaml 5.4 and older
# versions of OCaml.
# See https://github.com/ocaml/ocaml/commit/1ef454907b19fba693a182296594d5b8024fa6f4 and
# https://github.com/ocaml/ocaml/commit/d643794245c17e87bda08924e19a680673de7429

$ opam-ci-check lint -r . 'foo.0.1.0:new=invalid' 2>&1 | tr '\n' ' ' | sed -E 's/[[:space:]]+/ /g'
opam-ci-check: pkg_spec… arguments: invalid element in list ('new=invalid'): invalid must be [true] or [false] Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]… Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.

Test for a missing value

$ opam-ci-check lint -r . 'foo.0.1.0:src='
opam-ci-check: invalid element in list ('src='): src= is an not a valid
attribute. Only [src=<path>] or [new=<true|false>] allowed
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]
# NOTE: We get rid of the line breaks in the output to work around
# differences in UTF-8 length calculation between OCaml 5.4 and older
# versions of OCaml.

$ opam-ci-check lint -r . 'foo.0.1.0:src=' 2>&1 | tr '\n' ' ' | sed -E 's/[[:space:]]+/ /g'
opam-ci-check: pkg_spec… arguments: invalid element in list ('src='): src= is not a valid attribute. Only [src=<path>] or [new=<true|false>] allowed Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]… Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.

Test for a valid key with no value

$ opam-ci-check lint -r . 'foo.0.1.0:src'
opam-ci-check: invalid element in list ('src'): src is an not a valid
attribute. Only [src=<path>] or [new=<true|false>] allowed
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
opam-ci-check: pkg_spec… arguments: invalid element in list ('src'): src is
not a valid attribute. Only [src=<path>] or [new=<true|false>]
allowed
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]

Test for `src` with a non-existent directory

$ opam-ci-check lint -r . 'foo.0.1.0:src=./not/a/dir'
opam-ci-check: invalid element in list ('src=./not/a/dir'): ./not/a/dir: No
such file or directory
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
opam-ci-check: pkg_spec… arguments: invalid element in list
('src=./not/a/dir'): ./not/a/dir: No such file or directory
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]

Test for invalid extra colons

$ opam-ci-check lint -r . 'foo.0.1.0:bing-bong:bang'
opam-ci-check: Invalid argument spec foo.0.1.0:bing-bong:bang. Argument specs
should be of the form arg[:k1=v1[,k2=v2]]
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [ARG]…
opam-ci-check: pkg_spec… arguments: Invalid argument spec
foo.0.1.0:bing-bong:bang. Argument specs should be of the form
arg[:k1=v1[,k2=v2]]
Usage: opam-ci-check lint [--checks=VAL] [--quiet] [--opam-repository=VAL] [OPTION]… [pkg_spec]…
Try 'opam-ci-check lint --help' or 'opam-ci-check --help' for more information.
[124]

Expand Down