[Bug 2077382] Re: [SRU] support additional parametes on deploy()

[Mauricio Faria de Oliveira]

Hi Alan,

Thanks for the revised debdiffs, and apologies for the delay.

So, I only did minor changes to versioning and dep-3 headers.

I asked for the patch pilot in #ubuntu-devel to review/sponsor
the v2 debdiff to the devel release (which I currently can't), 
and then I can sponsor to the stable releases (done more v2s).

Here are my changes, for your reference, as these are slightly
tricky in the first few times (and you started with a corner
case where multiple ubuntu series have the same version!) :)
but it should become easy as you work on more and more SRUs.

Please consider these for your future SRUs, as these might
help with review round-trips depending on reviewer/sponsor.

1) Starting with the current versions in the stable and devel releases:

	$ rmadison -a source python-libmaas
	 python-libmaas | 0.6.0-0ubuntu1         | bionic/universe        | source
	 python-libmaas | 0.6.4-0ubuntu1         | focal/universe         | source
	 python-libmaas | 0.6.4-0ubuntu1         | jammy/universe         | source
	 python-libmaas | 0.6.8-0ubuntu0.22.04.1 | jammy-updates/universe | source
	 python-libmaas | 0.6.8-0ubuntu2         | noble/universe         | source
	 python-libmaas | 0.6.8-0ubuntu2         | oracular/universe      | source
	 python-libmaas | 0.6.8-0ubuntu2         | plucky/universe        | source

And doing the version increments according to the guidelines in [1]:

	p: 0.6.8-0ubuntu2 > 0.6.8-0ubuntu3
	o: 0.6.8-0ubuntu2 > 0.6.8-0ubuntu2.24.10.1
	n: 0.6.8-0ubuntu2 > 0.6.8-0ubuntu2.24.04.1
	j: 0.6.8-0ubuntu0.22.04.1 > 0.6.8-0ubuntu0.22.04.2

Notice the devel release is incremented by '1' while stable
releases are usually incremented by '.1' except if multiple
releases have the same version number, which are incremented
by '.YY.MM.1' where YY.MM is the release version (eg, 24.10).

2) On DEP-3 headers [2], to be honest, the only header I found
incorrect is 'Origin: upstream, backport', with 2 keywords
(only one is to be used, if any) and no URL to the commit.

I updated it to 'Origin: upstream, <URL>' since there are
no changes (not even context lines) for the patch to apply
in the Ubuntu source package (otherwise, use 'backport').

The headers 'Forwarded:' and 'Applied-Upstream:' in this
case are not required, since the patch is already applied
upstream (no longer in a state where it was Forwarded to
the upstream project but not yet clear whether it would
be applied upstream, under which a reference to a mailing
list patch or github PR would be helpful to track it until
it made it upstream).
'Origin' with the commit URL does provide the meaning of
'Applied-Upstream'. I removed Forwarded/Applied-Upstream.

Links:
[1] https://wiki.ubuntu.com/SecurityTeam/UpdatePreparation#Update_the_packaging
[2] https://dep-team.pages.debian.net/deps/dep3/

-- 
You received this bug notification because you are a member of Ubuntu
Sponsors, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/2077382

Title:
  [SRU] support additional parametes on deploy()

Status in python-libmaas package in Ubuntu:
  In Progress
Status in python-libmaas source package in Jammy:
  In Progress
Status in python-libmaas source package in Noble:
  In Progress
Status in python-libmaas source package in Oracular:
  In Progress
Status in python-libmaas source package in Plucky:
  In Progress

Bug description:
  [ Impact ]

  * This SRU is not addressing an existing problem but adds support for
  two additional optional parameters being ephemeral_deploy and
  enable_hw_sync on deploy(). For more details please see (1).

  
  [ Test Plan ]

  * Pre-Requisits: A MAAS controller, an API key as well as a free
  physical machine or VM to perform the deployment tests.

  * Install the current version of python3-libmaas
  (0.6.8-0ubuntu0.22.04.1), then perform a deployment. Validate the
  final results, including the final machine state of Deployed and any
  other tests such as SSH. Release the machine after he validation is
  complete.

  * Install the modified python3-libmaas (0.6.8-0ubuntu0.22.04.2), then
  perform a new deployment. Verify the deployment results, similar to
  the previous step. Release the machine after completion. This step
  ensures there are no regressions as the newly introduced parameters
  are set to False by default.

  * Repeat the deployment while still on modified version. This time
  supply the new additional parameters ephemeral_deploy=True,
  enable_hw_sync=True. Verify the final results and release the machine.
  Please note that since this is an ephemeral deployment, it completes
  very quickly.

  * To help streamlining the test process, a test script has been
  provided and attached to the bug. It requires maas_endpoint as well as
  maas_apikey variables to be filled in the source before being
  utilized. Please note that install_python_libmaas_modified() currently
  installs the modified package from a temporary PPA - That would
  require a modification to install the modified package from the
  proposed pocket and similar.

  * To manually validate an Ephemeral deployment, SSH to the deployed
  machine and issue the following command, while comparing the output
  (Note overlayroot):

  $ mount | grep -w /
  overlayroot on / type overlay (rw,relatime,lowerdir=/media/root-ro,upperdir=/media/root-rw/overlay,workdir=/media/root-rw/overlay-workdir/_,xino=off)

  * To manually validate the presence of Hardware Sync, issue the
  following command. Note "Finished MAAS Hardware Sync Service" message
  line in the output.

  $ sudo systemctl status maas_hardware_sync

  
  [ Where problems could occur ]

  * Due to the nature of the change and the additional parameters being
  optional we are not expecting any adverse effect on existing
  integration using python-libmaas.

  (1) https://github.com/canonical/python-libmaas/issues/300

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/python-libmaas/+bug/2077382/+subscriptions