puppet-lint-manifest_whitespace-check 0.0.1 → 0.1.6

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

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_closing_bracket_before' do
+  let(:closing_bracket_msg) { 'there should be no whitespace or a single newline before a closing bracket' }
+
+  context 'with no spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+          $value4 = ['somekey']
+          $value5 = []
+          $value6 = {}
+          $value7 = "x${server_facts['environment']}y"
+
+          if somecondition {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 0 problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+  end
+
+  context 'with too many spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+          $value = [{ 'key' => 'value' }  ]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+
+          ]
+          $value3 = myfunc($value1)
+          $value4 = ['somekey' ]
+          $value5 = [ ]
+          $value6 = {}
+          $value7 = "x${server_facts['environment']}y"
+
+          if somecondition {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile' ],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 5 problems' do
+        expect(problems).to have(5).problems
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(closing_bracket_msg).on_line(9).in_column(33)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect 5 problems' do
+        expect(problems).to have(5).problems
+      end
+
+      it 'should fix a error' do
+        expect(problems).to contain_fixed(closing_bracket_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+              $value4 = ['somekey']
+              $value5 = []
+              $value6 = {}
+              $value7 = "x${server_facts['environment']}y"
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+end
+
+describe 'manifest_whitespace_closing_bracket_after' do
+  let(:closing_bracket_msg) { 'there should be either a bracket, comma, colon, closing quote or a newline after a closing bracket, or whitespace and none of the aforementioned' }
+
+  context 'with spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+          $value = { 'key' => ['value'] }
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            } ,
+          ]
+
+          $value2bis = [
+            'value',
+          ] # this comment is fine
+
+          $value3 = myfunc([] )
+          $value4 = ['somekey']
+          $value5 = []
+          $value6 = {}
+          $value7 = "x${server_facts['environment']}y"
+
+          if somecondition {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile'] ,
+            }
+            class { 'example3': }
+          }
+          if someothercondition { include ::otherclass }
+
+          package { ['package1', 'package2']:
+            ensure   => installed,
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 3 problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(closing_bracket_msg).on_line(9).in_column(32)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should fix a error' do
+        expect(problems).to contain_fixed(closing_bracket_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = { 'key' => ['value']}
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                } ,
+              ]
+
+              $value2bis = [
+                'value',
+              ] # this comment is fine
+
+              $value3 = myfunc([])
+              $value4 = ['somekey']
+              $value5 = []
+              $value6 = {}
+              $value7 = "x${server_facts['environment']}y"
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+                class { 'example3': }
+              }
+              if someothercondition { include ::otherclass }
+
+              package { ['package1', 'package2']:
+                ensure   => installed,
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_two_empty_lines' do
+  let(:single_space_msg) { 'there should be no two consecutive empty lines' }
+
+  context 'with two spaces' do
+    let(:code) do
+      <<~EOF
+        class { 'example2':
+          param1 => 'value1',
+
+
+          param2 => 'value2',
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(single_space_msg).on_line(4).in_column(1)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_space_msg)
+      end
+
+      it 'should fix the space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            class { 'example2':
+              param1 => 'value1',
+
+              param2 => 'value2',
+            }
+          EOF
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,792 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_opening_brace_before' do
+  let(:opening_brace_msg) { 'there should be a single space before an opening brace' }
+
+  context 'with comment only' do
+    let(:code) do
+      <<~EOF
+        $value7 = {
+          # nothing
+        }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'with no spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ){
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+          $value4 = ['somekey']
+          $value5 = []
+          $value6 = {}
+          $value7 = {
+            # nothing
+          }
+
+          if somecondition{
+            class{ 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect three problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(8).in_column(2)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect three problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+              $value4 = ['somekey']
+              $value5 = []
+              $value6 = {}
+              $value7 = {
+                # nothing
+              }
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with two spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        )  {
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition  {
+            class  { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(8).in_column(4)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect a single problem' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should remove a space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with newline' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        )
+        {
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition
+          {
+            class
+            { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(1)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect a single problem' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should fix the newline' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with comment' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) # some generic comment
+        {
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition # some generic comment
+          {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(0).problem
+      end
+    end
+  end
+
+  context 'with good inherits' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) inherits otherclass {
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with bad inherits' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) inherits otherclass{
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition {
+            class { 'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(8).in_column(22)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect a missing space' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should add the space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) inherits otherclass {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+end
+
+describe 'manifest_whitespace_opening_brace_after' do
+  let(:opening_brace_msg) { 'there should be a single space or single newline after an opening brace' }
+
+  context 'with two spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+          $value = [{  'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+          $value4 = ['somekey']
+          $value5 = []
+          $value6 = {}
+          $value7 = {
+            # nothing
+          }
+
+          if somecondition {
+            class {  'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 2 problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(14)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect 2 problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+              $value4 = ['somekey']
+              $value5 = []
+              $value6 = {}
+              $value7 = {
+                # nothing
+              }
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with no spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+          $value = [{'key' => 'value' }]
+          $value2 = [
+            {
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition {
+            class {'example2':
+              param1  => 'value1',
+              require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 2 problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(14)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect 2 problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+
+              if somecondition {
+                class { 'example2':
+                  param1  => 'value1',
+                  require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with two newlines' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) {
+
+          $value = [{ 'key' => 'value' }]
+          $value2 = [
+            {
+
+              'key' => 'value1',
+            },
+            {
+              'key' => 'value2',
+            },
+          ]
+          $value3 = myfunc($value1)
+
+          if somecondition {
+
+            class {
+
+              'example2':
+                param1  => 'value1',
+                require => File['somefile'],
+            }
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(1)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_fixed(opening_brace_msg)
+      end
+
+      it 'should add spaces' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) {
+              $value = [{ 'key' => 'value' }]
+              $value2 = [
+                {
+                  'key' => 'value1',
+                },
+                {
+                  'key' => 'value2',
+                },
+              ]
+              $value3 = myfunc($value1)
+
+              if somecondition {
+                class {
+                  'example2':
+                    param1  => 'value1',
+                    require => File['somefile'],
+                }
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+end