puppet-lint-nine-check 0.4.0 → 0.5.0

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

@@ -0,0 +1,257 @@
+require "spec_helper"
+
+describe "class_alignment_params_newline" do
+  let(:msg) { "`%s` should be in a new line (expected in line %d, but found it in line %d)" }
+
+  context "with fix disabled" do
+    context "tidy code" do
+      let(:code) do
+        <<-END
+          class bar(
+                                                        $someparam = 'somevalue',
+                                                        $another,
+            String                                      $nope,
+                                                        $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                      $third     = 'meh',
+            Array[Int, Int]                             $asdf      = 'asdf',
+          ) { }
+        END
+      end
+
+      it "should detect 0 problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "messy code" do
+      let(:code) do
+        <<-END
+          class bar(                                                        $someparam = 'somevalue',
+            $another, String $nope, $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh', Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      it "should detect 4 problems" do
+        expect(problems).to have(4).problems
+      end
+
+      it "should create four warnings" do
+        expect(problems).to contain_warning(format(msg, "$someparam", 2, 1)).on_line(1).in_column(77)
+        expect(problems).to contain_warning(format(msg, "$nope", 3, 2)).on_line(2).in_column(30)
+        expect(problems).to contain_warning(format(msg, "$foo", 3, 2)).on_line(2).in_column(37)
+        expect(problems).to contain_warning(format(msg, "$asdf", 6, 5)).on_line(5).in_column(101)
+      end
+    end
+  end
+
+  context "with fix enabled" do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context "messy code" do
+      let(:code) do
+        <<-END
+          class bar(                                                        $someparam = 'somevalue',
+            $another, String $nope, $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh', Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class bar(
+            $someparam = 'somevalue',
+            $another,
+            String $nope,
+            $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh',
+            Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      it "should fix the problems" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context "in a single line" do
+      let(:code) do
+        <<-END
+          class foo ($foo = 1, $bar = $a) {}
+          class foo ($foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+          class bar ($foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a,) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+          class aaa ( Integer $foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a,) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+          class bbb ( $foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a, ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+
+          class eee (
+            $foo = 1,
+            $workers = max($::processorcount, 1),
+            $database_path = $aaa,) inherits sap_zabbix::params { }
+          { }
+
+          class fff ($foo, $bar=[], $foo, $bar=[], $foo, $bar=[], $listen_ips = [$::ipaddress]) {}
+
+          define ggg ($foo, $bar=[]) {}
+
+          define long_ggg ($foo, $bar=[], $foo, $bar=[], $foo, $bar=[], $foo, $bar=[]) {}
+
+          define asdf ($prefix, $pattern, $expire, $port, $prefix, $pattern, $expire, $port) { }
+
+          define asdf ($prefix, $pattern, $expire, $port, $prefix, $pattern=$a and $b, $epe=-$foo, $port=!$foo) { }
+
+          class aaa (
+            $aaa = func('bbb', $ccc), $bar = $a, $foo = 1, $bar = $a,
+          ) {}
+
+          class name (
+            Boolean             $foo,
+            Optional[String[1]] $bar,
+          ) { }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo ($foo = 1, $bar = $a) {}
+          class foo (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a
+          ) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+          class bar (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+          class aaa (
+            Integer $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+          class bbb (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+
+          class eee (
+            $foo = 1,
+            $workers = max($::processorcount, 1),
+            $database_path = $aaa,
+          ) inherits sap_zabbix::params { }
+          { }
+
+          class fff (
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $listen_ips = [$::ipaddress]
+          ) {}
+
+          define ggg ($foo, $bar=[]) {}
+
+          define long_ggg (
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[]
+          ) {}
+
+          define asdf (
+            $prefix,
+            $pattern,
+            $expire,
+            $port,
+            $prefix,
+            $pattern,
+            $expire,
+            $port
+          ) { }
+
+          define asdf (
+            $prefix,
+            $pattern,
+            $expire,
+            $port,
+            $prefix,
+            $pattern=$a and $b,
+            $epe=-$foo,
+            $port=!$foo
+          ) { }
+
+          class aaa (
+            $aaa = func('bbb', $ccc),
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class name (
+            Boolean             $foo,
+            Optional[String[1]] $bar,
+          ) { }
+        END
+      end
+
+      it "should fix the problems" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,321 @@
+require "spec_helper"
+
+describe "class_alignment_params" do
+  let(:msg) { "indentation of $ is not properly aligned (expected in column %d, but found it in column %d)" }
+
+  context "with fix disabled" do
+    context "with correct indentation" do
+      let(:code) do
+        <<-END
+          class foo (
+            $foo   = 1,
+            $bar   = 2,
+            $gronk = 3,
+            $baz   = 4,
+            $meh   = 5,
+          ) {}
+        END
+      end
+
+      it "should not detect any problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "single resource with a misaligned $" do
+      let(:code) do
+        <<-END
+          class foo (
+            $foo = 1,
+          $bar = 2,
+          $gronk = 3,
+          $baz  = 4,
+           $meh = 5,
+          ) {}
+        END
+      end
+
+      it "should detect four problems" do
+        expect(problems).to have(4).problems
+      end
+
+      it "should create four warnings" do
+        expect(problems).to contain_warning(format(msg, 13, 11)).on_line(3).in_column(11)
+        expect(problems).to contain_warning(format(msg, 13, 11)).on_line(4).in_column(11)
+        expect(problems).to contain_warning(format(msg, 13, 11)).on_line(5).in_column(11)
+        expect(problems).to contain_warning(format(msg, 13, 12)).on_line(6).in_column(12)
+      end
+    end
+
+    context "complex resource with a misaligned $" do
+      let(:code) do
+        <<-END
+          class foo (
+            $foo = 1,
+          $bar   = $baz ? {
+              gronk => 2,
+              meh => 3,
+            },
+              $meep = 4,
+                $bah= 5,
+          ) {}
+        END
+      end
+
+      it "should detect three problems" do
+        expect(problems).to have(3).problems
+      end
+
+      it "should create three warnings" do
+        expect(problems).to contain_warning(format(msg, 13, 11)).on_line(3).in_column(11)
+        expect(problems).to contain_warning(format(msg, 13, 15)).on_line(7).in_column(15)
+        expect(problems).to contain_warning(format(msg, 13, 17)).on_line(8).in_column(17)
+      end
+    end
+
+    context "resource with unaligned $ in commented line" do
+      let(:code) do
+        <<-END
+          class foo (
+            $ensure = directory,
+            # $purge = true,
+          ) {}
+        END
+      end
+
+      it "should not detect any problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "multiline resource with a single line of params" do
+      let(:code) do
+        <<-END
+          class mymodule::do_thing (
+            $whatever = 'bar', $one = 'two',
+          ) {}
+        END
+      end
+
+      it "should not detect any problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "resource with aligned $ too far out" do
+      let(:code) do
+        <<-END
+          class foo (
+                $ensure  = file,
+                $mode    = '0444',
+          ) {}
+        END
+      end
+
+      it "should detect 0 problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "resource with multiple params where one is an empty hash" do
+      let(:code) do
+        <<-END
+          class foo (
+            $a = true,
+            $b = {
+            }
+          ) {}
+        END
+      end
+
+      it "should not detect any problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "multiline resource with multiple params on a line" do
+      let(:code) do
+        <<-END
+          class test (
+            $a = 'foo', $bb = 'bar',
+            $ccc = 'baz',
+          ) {}
+        END
+      end
+
+      it "should detect 0 problems" do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context "with fix enabled" do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context "single resource with a misaligned $" do
+      let(:code) do
+        <<-END
+          class foo (
+            $foo = 1,
+              $bar = 2,
+              $gronk = 3,
+                $baz = 4,
+          $meh = 5,
+          ) {}
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo (
+            $foo = 1,
+            $bar = 2,
+            $gronk = 3,
+            $baz = 4,
+            $meh = 5,
+          ) {}
+        END
+      end
+
+      it "should detect four problems" do
+        expect(problems).to have(4).problems
+      end
+
+      it "should fix the manifest" do
+        expect(problems).to contain_fixed(format(msg, 13, 15)).on_line(3).in_column(15)
+        expect(problems).to contain_fixed(format(msg, 13, 15)).on_line(4).in_column(15)
+        expect(problems).to contain_fixed(format(msg, 13, 17)).on_line(5).in_column(17)
+        expect(problems).to contain_fixed(format(msg, 13, 11)).on_line(6).in_column(11)
+      end
+
+      it "should align the class_paramss" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context "complex resource with a misaligned =" do
+      let(:code) do
+        <<-END
+          class foo (
+            $foo = 1,
+          $bar = $baz ? {
+              gronk => $a,
+              meh => $b,
+            },
+          $meep= 4,
+          $bah = 5,
+          ) {}
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo (
+            $foo = 1,
+            $bar = $baz ? {
+              gronk => $a,
+              meh => $b,
+            },
+            $meep= 4,
+            $bah = 5,
+          ) {}
+        END
+      end
+
+      it "should detect three problems" do
+        expect(problems).to have(3).problems
+      end
+
+      it "should fix the manifest" do
+        expect(problems).to contain_fixed(format(msg, 13, 11)).on_line(3).in_column(11)
+        expect(problems).to contain_fixed(format(msg, 13, 11)).on_line(7).in_column(11)
+        expect(problems).to contain_fixed(format(msg, 13, 11)).on_line(8).in_column(11)
+      end
+
+      it "should align the class_paramss" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context "multiline resource with multiple params on a line" do
+      let(:code) do
+        <<-END
+          class test (
+            $a = 'foo', $bb = 'bar',
+          $ccc = 'baz',
+          ) {}
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class test (
+            $a = 'foo', $bb = 'bar',
+            $ccc = 'baz',
+          ) {}
+        END
+      end
+
+      it "should detect 1 problem" do
+        expect(problems).to have(1).problems
+      end
+
+      it "should fix 1 problem" do
+        expect(problems).to contain_fixed(format(msg, 13, 11)).on_line(3).in_column(11)
+      end
+
+      it "should move the extra param onto its own line and realign" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context "multiline resource with inline variables" do
+      let(:code) do
+        <<-END
+          class name (
+            $aaa = function('foo', 'bar'),
+              $bbb = function('foo', 'bar'),
+            Boolean $key1 = false,
+            Enum['never', 'allow', 'try', 'demand'] $key2,
+          $materializer_version = $foo ? {
+              default => "foo ${bar} baz ${gronk} qux 0.4.1-1.el${::facts['operatingsystemmajrelease']}"
+          }) { }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class name (
+                                                    $aaa = function('foo', 'bar'),
+                                                    $bbb = function('foo', 'bar'),
+            Boolean                                 $key1 = false,
+            Enum['never', 'allow', 'try', 'demand'] $key2,
+                                                    $materializer_version = $foo ? {
+              default => "foo ${bar} baz ${gronk} qux 0.4.1-1.el${::facts['operatingsystemmajrelease']}"
+          }) { }
+        END
+      end
+
+      it "should detect 4 problems" do
+        expect(problems).to have(4).problems
+      end
+
+      it "should fix 4 problems" do
+        expect(problems).to contain_fixed(format(msg, 53, 13)).on_line(2).in_column(13)
+        expect(problems).to contain_fixed(format(msg, 53, 15)).on_line(3).in_column(15)
+        expect(problems).to contain_fixed(format(msg, 53, 21)).on_line(4).in_column(21)
+        expect(problems).to contain_fixed(format(msg, 53, 11)).on_line(6).in_column(11)
+      end
+
+      it "should move the extra param onto its own line and realign" do
+        expect(manifest).to eq(fixed)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "rspec/collection_matchers"
 require "puppet-lint"
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-nine-check
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nine Internet Solutions AG
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -122,10 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-    A pupet-lint to check to ensure you are not using Nine legacy facts like `$::nine_location`
-    or `$facts['nine_location']`. You should use the new structured facts like
-    `$facts['nine_metadata']['location']` instead.
+description: "  A collection of pupet-lint checks used at Nine.\n"
 email:
 - support@nine.ch
 executables: []
@@ -134,6 +131,9 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/puppet-lint/plugins/class_alignment.rb
+- lib/puppet-lint/plugins/class_alignment/helper.rb
+- lib/puppet-lint/plugins/class_alignment_params_newline.rb
 - lib/puppet-lint/plugins/concatenated_template_files.rb
 - lib/puppet-lint/plugins/explicit_hiera_class_param_lookup.rb
 - lib/puppet-lint/plugins/nine_legacy_facts.rb
@@ -141,6 +141,9 @@ files:
 - lib/puppet-lint/plugins/template_file_extension.rb
 - lib/puppet-lint/plugins/trailing_newline.rb
 - lib/puppet-lint/plugins/world_writable_files.rb
+- spec/puppet-lint/plugins/class_alignment_equals_spec.rb
+- spec/puppet-lint/plugins/class_alignment_params_newline_spec.rb
+- spec/puppet-lint/plugins/class_alignment_params_spec.rb
 - spec/puppet-lint/plugins/concatenated_template_files_spec.rb
 - spec/puppet-lint/plugins/explicit_hiera_class_param_lookup_spec.rb
 - spec/puppet-lint/plugins/nine_legacy_facts_spec.rb
@@ -168,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A puppet-lint plugin for different checks used at Nine.