puppet-lint-scheduled_resource_required-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b29c2214c6708dbe83ffa84d33d10c3a49a0fb03bfbd1689af2b5ad126b4a87
+  data.tar.gz: 0747a26d9b402dea0648758e669f0ca9e1f009e3c46ae4379c51c45bfbbef6b0
+SHA512:
+  metadata.gz: 95b191d6d7e4779983b37e207896ebdcd6c99ea2197aaf49844f5f8e284f36e57d48ae3644d073429cb232af6b56d7631d1883c360dc30b2f1f9588dfa28465e
+  data.tar.gz: e482b318704b4fb9c30a7b93ec120f193cb392e69606c8a1c14b9aa46f33d9c98dc47e078a1b5ddc6b23772920cf60a960062c8ace43f34abffd937294f4d80e

data/README.md

@@ -0,0 +1,2 @@
+Following this tutorial:
+http://puppet-lint.com/developer/tutorial/

data/lib/puppet-lint/plugins/check_scheduled_resource_required.rb

@@ -0,0 +1,22 @@
+PuppetLint.new_check(:scheduled_resource_required) do
+  def check
+    resource_indexes.each do |resource|
+      if ['exec', 'package'].include? resource[:type].value
+        has_schedule_attr = false
+        resource[:tokens].each_with_index do |token|
+          if token.next_code_token
+            has_schedule_attr = true if token.value == 'schedule' and token.next_code_token.type == :FARROW
+          end
+        end
+
+        unless has_schedule_attr
+          notify :warning, {
+            :message => "expected schedule attribute on #{resource[:type].value} resource",
+            :line => resource[:tokens][-1].line,
+            :column => resource[:tokens][-1].column,
+          }
+        end
+      end
+    end
+  end
+end

data/spec/puppet-lint/plugins/check_scheduled_resource_required_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe 'scheduled_resource_required' do
+  context 'when exec resource has no schedule attribute' do
+    let(:code) do
+      <<-PUPPET
+        exec { 'test':
+          command => '/bin/true',
+        }
+      PUPPET
+    end
+
+    it 'should detect a problem' do
+      expect(problems).to contain_warning('expected schedule attribute on exec resource').on_line(3)
+    end
+  end
+
+  context 'when exec resource has schedule attribute' do
+    let(:code) do
+      <<-PUPPET
+        exec { 'test':
+          command  => '/bin/true',
+          schedule => 'maintenance_window',
+        }
+      PUPPET
+    end
+
+    it 'should not detect a problem' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'when package resource has no schedule attribute' do
+    let(:code) do
+      <<-PUPPET
+        package { 'httpd':
+          ensure => installed,
+        }
+      PUPPET
+    end
+
+    it 'should detect a problem' do
+      expect(problems).to contain_warning('expected schedule attribute on package resource').on_line(3)
+    end
+  end
+
+  context 'when package resource has schedule attribute' do
+    let(:code) do
+      <<-PUPPET
+        package { 'httpd':
+          ensure   => installed,
+          schedule => 'maintenance_window',
+        }
+      PUPPET
+    end
+
+    it 'should not detect a problem' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'when exec and package resources have no schedule attribute' do
+    let(:code) do
+      <<-PUPPET
+        exec { 'test':
+          command => '/bin/true',
+        }
+
+        package { 'httpd':
+          ensure => installed,
+        }
+      PUPPET
+    end
+
+    it 'should detect two problems' do
+      expect(problems).to have(2).problems
+    end
+  end
+
+  context 'when another resource type (e.g. file) is missing schedule' do
+    let(:code) do
+      <<-PUPPET
+        file { '/tmp/test':
+          ensure => present,
+        }
+      PUPPET
+    end
+
+    it 'should not detect a problem' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'when exec resource has "schedule" keyword, but it is not an attribute' do
+    let(:code) do
+      <<-PUPPET
+        exec { 'test':
+          command => 'schedule',
+        }
+      PUPPET
+    end
+
+    it 'should detect a problem' do
+      expect(problems).to contain_warning('expected schedule attribute on exec resource').on_line(3)
+    end
+  end
+
+  context 'when package resource has "schedule" keyword, but it is not an attribute' do
+    let(:code) do
+      <<-PUPPET
+        package { 'test':
+          command => 'schedule',
+        }
+      PUPPET
+    end
+
+    it 'should detect a problem' do
+      expect(problems).to contain_warning('expected schedule attribute on package resource').on_line(3)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'puppet-lint'
+require_relative '..\lib\puppet-lint\plugins\check_scheduled_resource_required.rb'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-scheduled_resource_required-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Landon Connell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A puppet-lint plugin to check if resource types involved in installing
+  or uninstalling software (e.g. exec or package) have a schedule attribute associated
+  with them.\n"
+email: landon.connell@wendys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/check_scheduled_resource_required.rb
+- spec/puppet-lint/plugins/check_scheduled_resource_required_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.com/wendys/retail-technology-puppet/puppet-lint-checks/scheduled-resource-required
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A puppet-lint plugin to check if resource types involved in installing or
+  uninstalling software (e.g. exec or package) have a schedule attribute associated
+  with them.
+test_files:
+- spec/puppet-lint/plugins/check_scheduled_resource_required_spec.rb
+- spec/spec_helper.rb