Merge pull request #1046 from puppetlabs/MODULES-11645

(MODULES-11645) Ignore services with restart option as 'no' in exists? method

Author: span786

lib/puppet/provider/docker_compose/ruby.rb

@@ -40,6 +40,9 @@ def exists?
 
     compose_services = compose_output['services']
 
+    # Remove services with restart: 'no' from the compose_services list as they are not expected to be running.
+    compose_services.reject! { |_k, v| v['restart'] == 'no' }
+
     return false if compose_services.count != compose_containers.uniq.count
 
     counts = Hash[*compose_services.each.map { |key, array|

spec/acceptance/compose_v3_spec.rb

@@ -92,6 +92,43 @@ class { 'docker::compose': }
     end
   end
 
+  context 'Creating compose projects with services having restart: no' do
+    before(:all) do
+      # Create a compose file with one service having restart: no
+      compose_content = <<-YAML
+version: '3.8'
+services:
+  db:
+    image: mysql:5.7
+    restart: always
+  web:
+    image: nginx
+    restart: no
+YAML
+      create_remote_file(hosts, "#{tmp_path}/docker-compose-restart-no.yml", compose_content)
+    end
+
+    let(:install_pp) do
+      <<-MANIFEST
+        docker_compose { 'restart_test':
+          compose_files => ['#{tmp_path}/docker-compose-restart-no.yml'],
+          ensure => present,
+        }
+      MANIFEST
+    end
+
+    it 'is idempotent' do
+      idempotent_apply(install_pp)
+    end
+
+    it 'finds the running service but ignores the restart: no service' do
+      # Assuming the compose file has one service with restart: always and one with restart: no
+      run_shell('docker inspect restart_test-db_1', expect_failures: false)
+      # The web service with restart: no should not be running
+      run_shell('docker inspect restart_test-web_1', expect_failures: true)
+    end
+  end
+
   context 'Requesting a specific version of compose' do
     let(:version) do
       '2.25.0'

spec/unit/lib/puppet/provider/docker_compose/ruby_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Puppet::Type.type(:docker_compose).provider(:ruby) do
+  let(:resource) do
+    Puppet::Type.type(:docker_compose).new(
+      name: 'test_project',
+      compose_files: ['/tmp/docker-compose.yml'],
+      provider: :ruby,
+    )
+  end
+
+  let(:provider) { resource.provider }
+
+  describe '#exists?' do
+    before(:each) do
+      allow(Puppet::Util::Platform).to receive(:windows?).and_return(false)
+      allow(provider).to receive(:execute).and_return(YAML.safe_load("services:\n  web:\n    image: mysql\n    restart: always\n"))
+      allow(provider).to receive(:docker).and_return("'db-mysql'\n")
+    end
+
+    it 'ignores services with restart: no' do
+      # Mock the compose_output to have services with restart: 'no'
+      allow(Puppet::Util::Yaml).to receive(:safe_load).and_return({
+                                                                    'services' => {
+                                                                      'web' => { 'image' => 'nginx', 'restart' => 'no' },
+                                                                      'db' => { 'image' => 'mysql', 'restart' => 'always' }
+                                                                    }
+                                                                  })
+
+      # Only db should be considered, and it matches the running container
+      expect(provider.exists?).to be true
+    end
+  end
+end