Merge ~lucaskanashiro/ubuntu/+source/puppet:fix-links-issue into ubuntu/+source/puppet:ubuntu/devel

[Lucas Kanashiro]

Fixes file's link attribute with ruby 3.0. This patch is not present in the upstream source tree nor in Debian, upstream does support ruby 3.0 properly but in the newer version (7.x) and Debian maintainers are still trying to move to that version (not willing to support 5.x). However, we are stuck to 5.x in Jammy and I believe kinetic will be released with the same version, so we need to make it work with ruby 3.0.

The patch I am proposing here is a workaround to this bug and it was tested by some users in LP #1969939. They do not find any issue with that but since this is a handcrafted patch there is always the risk to introduce unexpected behavior.

PPA with the proposed package:

https://launchpad.net/~lucaskanashiro/+archive/ubuntu/puppet/

autopkgtest summary:

autopkgtest [17:08:06]: @@@@@@@@@@@@@@@@@@@@ summary
command1 PASS
command2 PASS
command3 PASS
command4 PASS
command5 PASS

[Athos Ribeiro (athos-ribeiro)]

Thanks, Lucas!

I looked for a change fixing the issue upstream. Then I realized this fixes a regression introduced by debian/patches/0017-PUP-10537-keyword-param-as-last-arg.patch. This patch was backported from upstream's 6.x and the APIs changed a lot since then.

I also screened the code for any bits that could possibly rely on the value of `links` not being set, and found no instances.

LGTM

review: Approve

[Lucas Kanashiro (lucaskanashiro)]

Thanks for the review Athos. Package uploaded:

Uploading puppet_5.5.22-4ubuntu2.dsc
Uploading puppet_5.5.22.orig.tar.gz
Uploading puppet_5.5.22.orig.tar.gz.asc
Uploading puppet_5.5.22-4ubuntu2.debian.tar.xz
Uploading puppet_5.5.22-4ubuntu2_source.buildinfo
Uploading puppet_5.5.22-4ubuntu2_source.changes

[Lucas Kanashiro (lucaskanashiro)]

I'll be preparing a MP with the same patch targeting Jammy.

Unmerged commits

c25202f... by Lucas Kanashiro on 2022-05-31

Update changelog

b35d7a0... by Lucas Kanashiro on 2022-05-31

Add patch to set file's link attribute to manage by default (LP: #1969939)

diff --git a/debian/changelog b/debian/changelog
index 9fd37cc..01cd764 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+puppet (5.5.22-4ubuntu2) kinetic; urgency=medium
+
+  * Add patch to set file's link attribute to manage by default (LP: #1969939)
+
+ -- Lucas Kanashiro <[e-mail]>  Tue, 31 May 2022 11:36:34 -0300
+
 puppet (5.5.22-4ubuntu1) kinetic; urgency=medium
 
   * Backport upstream patches (LP: #1969939):
diff --git a/debian/patches/0019-Set-file-links-attribute-to-manage-by-default.patch b/debian/patches/0019-Set-file-links-attribute-to-manage-by-default.patch
 new file mode 100644
index 0000000..ddf8161
--- /dev/null
+++ b/debian/patches/0019-Set-file-links-attribute-to-manage-by-default.patch
@@ -0,0 +1,31 @@
+From: Lucas Kanashiro <[e-mail]>
+Date: Tue, 31 May 2022 11:32:57 -0300
+Subject: Set file links attribute to manage by default
+
+This patch is not applied in the upstream source tree, this is a
+workaround written by me to attempt to fix the issue reported by users.
+
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/puppet/+bug/1969939
+---
+ lib/puppet/file_serving/metadata.rb | 8 +++++++-
+ 1 file changed, 7 insertions(+), 1 deletion(-)
+
+diff --git a/lib/puppet/file_serving/metadata.rb b/lib/puppet/file_serving/metadata.rb
+index 08e2ca5..ec4d09d 100644
+--- a/lib/puppet/file_serving/metadata.rb
++++ b/lib/puppet/file_serving/metadata.rb
+@@ -136,7 +136,13 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
+     @destination = data.delete('destination')
+     @source      = data.delete('source')
+     @content_uri = data.delete('content_uri')
+-    links = data.fetch('links', nil) || data.fetch(:links, nil)
++    # This is a workaround to fix the issue Ubuntu users reported in LP #1969939.
++    # Once links variable is nil we get a "undefined method `to_sym' for nil:NilClass"
++    # in the links= method in file_serving/base.rb.
++    # According to the upstream doc
++    # (https://puppet.com/docs/puppet/5.5/types/file.html#file-attribute-links),
++    # the default value is 'manage', therefore, setting the default to :manage.
++    links = data.fetch('links', :manage) || data.fetch(:links, :manage)
+     relative_path = data.fetch('relative_path', nil) || data.fetch(:relative_path, nil)
+     source = @source || data.fetch(:source, nil)
+     super(path, links: links, relative_path: relative_path, source: source)
diff --git a/debian/patches/series b/debian/patches/series
index ff870c2..24e0778 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -16,3 +16,4 @@
 0016-PUP-11046-Implement-RFC2396-style-escape-unescape.patch
 0017-PUP-10537-keyword-param-as-last-arg.patch
 0018-PUP-11045-ruby-openssl-now-sets-store_context.error.patch
+0019-Set-file-links-attribute-to-manage-by-default.patch