Merge branch 'devel' into 'test'

Devel

See merge request pm-liuit/liu_pulpcore!114

lib/puppet/provider/liu_pulpcore_group/liu_pulpcore_group.rb

@@ -19,12 +19,19 @@ class Puppet::Provider::LiuPulpcoreGroup::LiuPulpcoreGroup < Puppet::ResourceApi
       result[:pulp_href] = group['pulp_href']
 
       result[:raw_members] = paginated { request("#{group['pulp_href']}/users/") }['results']
-      result[:members] = result[:raw_members].map { |member| member['username'] }
+      result[:members] = result[:raw_members].map { |member| member['username'] }.sort
 
       result
     end
   end
 
+  def canonicalize(_context, resources)
+    resources.each do |group|
+      group[:members]&.sort!
+    end
+    resources
+  end
+
   def create(_context, name, should)
     data = execute('create', name, should)
     cache << data.transform_keys(&:to_sym).slice(:pulp_href, *attribute_keys).merge(name: name)

lib/puppet/provider/liu_pulpcore_group_role/liu_pulpcore_group_role.rb

@@ -30,6 +30,9 @@ class Puppet::Provider::LiuPulpcoreGroupRole::LiuPulpcoreGroupRole < Puppet::Res
           result[:base_href] = group['pulp_href']
           result[:raw_roles] = paginated(per_page: 1000) { request("#{group['pulp_href']}/roles/", query: { exclude_fields: 'permissions,description', role: namevar[:role] }) }['results']
           result.merge! parse_roles(result[:raw_roles], workaround: true).transform_keys(&:to_sym)
+
+          result[:object].sort_by!(&:to_s)
+          result[:domain].sort_by!(&:to_s)
         end
 
         result
@@ -37,6 +40,14 @@ class Puppet::Provider::LiuPulpcoreGroupRole::LiuPulpcoreGroupRole < Puppet::Res
     end
   end
 
+  def canonicalize(_context, resources)
+    resources.each do |group_role|
+      group_role[:object]&.sort_by!(&:to_s)
+      group_role[:domain]&.sort_by!(&:to_s)
+    end
+    resources
+  end
+
   def create(_context, name, should)
     execute('create', name, should)
   end

lib/puppet/provider/liu_pulpcore_role/liu_pulpcore_role.rb

@@ -18,10 +18,18 @@ class Puppet::Provider::LiuPulpcoreRole::LiuPulpcoreRole < Puppet::ResourceApi::
       result[:name] = role['name']
       result[:pulp_href] = role['pulp_href']
       result[:locked] = role['locked']
+      result[:permissions].sort!
       result
     end
   end
 
+  def canonicalize(_context, resources)
+    resources.each do |role|
+      role[:permissions]&.sort_by!(&:to_s)
+    end
+    resources
+  end
+
   def create(_context, name, should)
     data = execute('create', name, should)
     cache << data.transform_keys(&:to_sym).slice(:pulp_href, *attribute_keys).merge(name: name)

lib/puppet/provider/liu_pulpcore_user_role/liu_pulpcore_user_role.rb

@@ -30,6 +30,9 @@ class Puppet::Provider::LiuPulpcoreUserRole::LiuPulpcoreUserRole < Puppet::Resou
           result[:base_href] = user['pulp_href']
           result[:raw_roles] = paginated(per_page: 1000) { request("#{user['pulp_href']}/roles/", query: { exclude_fields: 'permissions,description', role: namevar[:role] }) }['results']
           result.merge! parse_roles(result[:raw_roles], workaround: true).transform_keys(&:to_sym)
+
+          result[:object].sort_by!(&:to_s)
+          result[:domain].sort_by!(&:to_s)
         end
 
         result
@@ -37,6 +40,14 @@ class Puppet::Provider::LiuPulpcoreUserRole::LiuPulpcoreUserRole < Puppet::Resou
     end
   end
 
+  def canonicalize(_context, resources)
+    resources.each do |user_role|
+      user_role[:object]&.sort_by!(&:to_s)
+      user_role[:domain]&.sort_by!(&:to_s)
+    end
+    resources
+  end
+
   def create(_context, name, should)
     execute('create', name, should)
   end

lib/puppet/type/liu_pulpcore_group.rb

@@ -12,7 +12,7 @@ Puppet::ResourceApi.register_type(
       members => [ 'dev-user' ],
     }
 EOS
-  features: [],
+  features: ['canonicalize'],
   attributes: {
     ensure: {
       type: 'Enum[present, absent]',

lib/puppet/type/liu_pulpcore_group_role.rb

@@ -22,7 +22,7 @@ Puppet::ResourceApi.register_type(
     object => [Liu_pulpcore_rpm_repository['testing']],
   }
 EOS
-  features: ['simple_get_filter'],
+  features: ['simple_get_filter', 'canonicalize'],
   title_patterns: [
     {
       pattern: %r{\A(?<group>[^/]+)/(?<role>.+)\Z},

lib/puppet/type/liu_pulpcore_role.rb

@@ -7,7 +7,7 @@ Puppet::ResourceApi.register_type(
   docs: <<-EOS,
 @summary Pulp RBAC role
 EOS
-  features: [],
+  features: ['canonicalize'],
   attributes: {
     ensure: {
       type: 'Enum[present, absent]',

lib/puppet/type/liu_pulpcore_user_role.rb

@@ -22,7 +22,7 @@ Puppet::ResourceApi.register_type(
     object => [Liu_pulpcore_rpm_repository['testing']],
   }
 EOS
-  features: ['simple_get_filter'],
+  features: ['simple_get_filter', 'canonicalize'],
   title_patterns: [
     {
       pattern: %r{\A(?<user>[^/]+)/(?<role>.+)\Z},

spec/fixtures/pulp_data/get_group_users.json

@@ -4,7 +4,11 @@
   "previous": null,
   "results": [
     {
-      "username": "example-user",
+      "username": "example-user2",
+      "pulp_href": "/pulp/api/v3/users/6/"
+    },
+    {
+      "username": "example-user1",
       "pulp_href": "/pulp/api/v3/users/5/"
     }
   ]

spec/integration/liu_pulpcore/catalog_spec.rb

@@ -335,7 +335,9 @@ RSpec.describe 'LiU_pulpcore integration test' do
                         body: '{}',
                       )
 
-        catalog.apply
+        report = catalog.apply.report
+        report.finalize_report
+        expect(report.status).to eq('changed')
 
         # Ensure all resources have been created
         assert_requested rpm_remote

spec/integration/liu_pulpcore/member_ordering_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'LiU_pulpcore member ordering integration test' do
+  let(:group_members) { ['example-user1', 'example-user2'] }
+  let(:group) { Puppet::Type.type(:liu_pulpcore_group).new(name: 'example-group', members: group_members) }
+
+  let(:catalog) do
+    Puppet::Resource::Catalog.new.tap do |cat|
+      cat.add_resource(group)
+    end
+  end
+
+  before(:each) do
+    allow(Puppet::Util::Storage).to receive(:store)
+
+    # Allows retrieving groups
+    stub_request(:get, 'http://pulpcore-api/pulp/api/v3/groups/?limit=100&offset=0')
+      .to_return(
+        status: 200,
+        body: File.read('spec/fixtures/pulp_data/get_groups.json'),
+      )
+
+    # Allow retrieving members assigned to the groups
+    stub_request(:get, 'http://pulpcore-api/pulp/api/v3/groups/1/users/?limit=100&offset=0')
+      .to_return(
+        status: 200,
+        body: File.read('spec/fixtures/pulp_data/get_group_users.json'),
+      )
+  end
+
+  describe 'with no differences' do
+    it 'does nothing' do
+      report = catalog.apply.report
+      report.finalize_report
+      expect(report.logs).to be_empty
+      expect(report.status).to eq('unchanged')
+    end
+  end
+
+  describe 'with ordering difference' do
+    let(:group_members) { ['example-user2', 'example-user1'] }
+
+    it 'performs no changes' do
+      report = catalog.apply.report
+      report.finalize_report
+      expect(report.logs).to be_empty
+      expect(report.status).to eq('unchanged')
+    end
+  end
+
+  describe 'with content difference' do
+    let(:group_members) { ['example-user'] }
+
+    it 'performs changes' do
+      del_req1 = stub_request(:delete, 'http://pulpcore-api/pulp/api/v3/groups/1/users/5/')
+                 .to_return(
+                   status: 200,
+                 )
+      del_req2 = stub_request(:delete, 'http://pulpcore-api/pulp/api/v3/groups/1/users/6/')
+                 .to_return(
+                   status: 200,
+                 )
+      add_req = stub_request(:post, 'http://pulpcore-api/pulp/api/v3/groups/1/users/')
+                .with(
+                  body: {
+                    username: 'example-user',
+                  },
+                )
+                .to_return(
+                  status: 200,
+                )
+
+      report = catalog.apply.report
+      report.finalize_report
+      expect(report.status).to eq('changed')
+
+      assert_requested del_req1
+      assert_requested del_req2
+      assert_requested add_req
+    end
+  end
+end

spec/spec_helper_local.rb

@@ -2,6 +2,7 @@
 
 require 'webmock/rspec'
 require_relative '../lib/puppet_x/liu_pulpcore/connection'
+require_relative '../lib/puppet_x/liu_pulpcore/resource_cache'
 
 def enable_pulp3_testing
   PuppetX::LiuPulpcore::Connection.class_eval do
@@ -9,6 +10,23 @@ def enable_pulp3_testing
   end
 end
 
+def drop_pulp3_caches
+  pulpcore_types = [:user, :group, :role]
+  [:deb, :rpm, :python].each do |plugin|
+    [:distribution, :publication, :remote, :repository].each do |type|
+      pulpcore_types << :"#{plugin}_#{type}"
+    end
+  end
+  pulpcore_types.map! { |type| :"liu_pulpcore_#{type}" }
+
+  pulpcore_types.each do |type|
+    provider = Puppet::Type.type(type).my_provider
+
+    provider.instance_variable_set :@cached_get, nil if provider.instance_variable_defined? :@cached_get
+    provider.instance_variable_set :@cache, nil if provider.instance_variable_defined? :@cache
+  end
+end
+
 def enable_pulp3_integration
   PuppetX::LiuPulpcore::Connection.class_eval do
     @config = nil
@@ -124,3 +142,9 @@ def allow_searching_full_cache
 end
 
 enable_pulp3_testing
+
+RSpec.configure do |config|
+  config.before(:each) do
+    drop_pulp3_caches
+  end
+end

spec/unit/puppet/provider/liu_pulpcore_group/liu_pulpcore_group_spec.rb

@@ -15,12 +15,17 @@ RSpec.describe Puppet::Provider::LiuPulpcoreGroup::LiuPulpcoreGroup do
       ensure: 'present',
       name: 'example-group',
       members: [
-        'example-user',
+        'example-user1',
+        'example-user2',
       ],
       pulp_href: '/pulp/api/v3/groups/1/',
       raw_members: [
         {
-          'username' => 'example-user',
+          'username' => 'example-user2',
+          'pulp_href' => '/pulp/api/v3/users/6/',
+        },
+        {
+          'username' => 'example-user1',
           'pulp_href' => '/pulp/api/v3/users/5/',
         },
       ],
@@ -66,21 +71,32 @@ RSpec.describe Puppet::Provider::LiuPulpcoreGroup::LiuPulpcoreGroup do
                 pulp_href: '/pulp/api/v3/groups/1/'
               }.to_json,
             )
-      req_member = stub_request(:post, 'http://pulpcore-api/pulp/api/v3/groups/1/users/')
-                   .with(
-                     body: {
-                       username: 'example-user',
-                     },
-                   )
-                   .to_return(
-                     status: 200,
-                     body: '{}',
-                   )
+      req_member1 = stub_request(:post, 'http://pulpcore-api/pulp/api/v3/groups/1/users/')
+                    .with(
+                      body: {
+                        username: 'example-user1',
+                      },
+                    )
+                    .to_return(
+                      status: 200,
+                      body: '{}',
+                    )
+      req_member2 = stub_request(:post, 'http://pulpcore-api/pulp/api/v3/groups/1/users/')
+                    .with(
+                      body: {
+                        username: 'example-user2',
+                      },
+                    )
+                    .to_return(
+                      status: 200,
+                      body: '{}',
+                    )
 
       provider.create(context, test_data[:name], test_data)
 
       assert_requested req
-      assert_requested req_member
+      assert_requested req_member1
+      assert_requested req_member2
     end
   end
 
@@ -102,13 +118,25 @@ RSpec.describe Puppet::Provider::LiuPulpcoreGroup::LiuPulpcoreGroup do
                        body: '{}',
                      )
 
-      test_data[:members] = ['another-user']
+      test_data[:members] = ['another-user', 'example-user2']
 
       provider.update(context, test_data[:name], test_data)
 
       assert_requested user_add_req
       assert_requested user_del_req
     end
+
+    it 'ignores user ordering' do
+      user_add_req = stub_request(:post, 'http://pulpcore-api/pulp/api/v3/groups/1/users/')
+      user_del_req = stub_request(:delete, %r{http://pulpcore-api/pulp/api/v3/groups/1/users/\d+/})
+
+      test_data[:members] = ['example-user2', 'example-user1']
+
+      provider.update(context, test_data[:name], test_data)
+
+      refute_requested user_add_req
+      refute_requested user_del_req
+    end
   end
 
   describe 'delete(context, name)' do