xapi-project / xen-api / 34970352916
79%
master: 79%

LAST BUILD BRANCH: asv/fix-snapshot-of
DEFAULT BRANCH: master
Ran
Jobs 1
Files 36
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 78.996%. Remained the same
34970352916

push

github

web-flow 
Make `xe` warn about ignored command-line parameters (#7255)

## Before this PR

As reported in [this forum
post](https://xcp-ng.org/forum/topic/12248/xe-sr-create-ignores-other-config-auto-scan-true-during-sr-creation),
a command like

```
$ xe sr-create name-label=my-iso-sr type=iso \
     device-config:location=192.0.2.1:/isos \
     other-config:auto-scan=true
<sr-uuid>
```

creates the SR, but neither acts on `other-config:auto-scan` nor reports
that it
went ignored.

## After this PR

This PR changes no behaviour until the report is explicitly switched on,
by
setting `report-ignored-params` to `warn` in one of two ways:

- **Server-side** — `report-ignored-params = warn` in `/etc/xapi.conf`.
- **Client-side** — `report-ignored-params=warn` on the `xe` invocation,
or once
  in `XE_EXTRA_ARGS` / `~/.xe`.

A client-side value overrides the server-side one.

With reporting enabled, the command from the previous section writes one
more
line:

```
Ignored parameter: other-config:auto-scan
```

The ignored parameters are reported on stderr, as diagnostic output
usually is.
Because a successful command can have ignored parameters too, this
breaks an
`xe` invariant — that a successful command writes nothing to stderr,
which some
scripts rely on. That is why reporting is off by default.

The command's own output, on stdout, is unaffected.

`*-list` commands are also unchanged: they read every extra `key=value`
as a
record filter (`xe vm-list power-state=running`), so an unrecognised one
is
already a hard error, not an ignored parameter.

A parameter can be reported as ignored for two distinct reasons: the
command finished but genuinely never needed it, or the command aborted
prematurely and never got as far as reading it. For example:

```
$ xe vdi-create sr-uuid=00000000 name-label=disk1 virtual-size=8GiB \
     type=user sm-config:foo=bar report-ignored-params=warn
Ignored parameter: type
Ignored parameter: sm-config:foo
The uuid you supplied was invali... (continued)

3667 of 4642 relevant lines covered (79.0%)

0.79 hits per line

Jobs
ID Job ID Ran Files Coverage
1 python3.11 - 34970352916.1 36
79.0
 GitHub Action Run
Source Files on build 34970352916