WIP: Removed provisioner and verifier specific linting support

This is not about removing linting form molecule completely, but is about moving towards having a single 'lint' command that runs all the linters user wants. YEP, THIS CHANGE LOOKS INSANE. Fixes: #2293
ansible · Jan 26, 2020 · 0cc5270 · 0cc5270
1 parent c960afe
commit 0cc5270
Show file tree

Hide file tree

Showing 53 changed files with 11 additions and 1,713 deletions.
diff --git a/docs/ci.rst b/docs/ci.rst
@@ -309,12 +309,8 @@ conflict.
         command: /usr/sbin/init
     provisioner:
       name: ansible
-      lint:
-        name: ansible-lint
     verifier:
       name: testinfra
-      lint:
-        name: flake8
 
 .. _`GitHub Actions`: https://github.com/features/actions
 .. _`Factors`: http://tox.readthedocs.io/en/latest/config.html#factors-and-factor-conditional-settings

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -88,13 +88,7 @@ Podman
 Lint
 ----
 
-Molecule handles project linting by invoking configurable linters.
-
-Yaml Lint
-^^^^^^^^^
-
-.. autoclass:: molecule.lint.yamllint.Yamllint()
-   :undoc-members:
+Molecule handles project linting by invoking and externa lint command.
 
 .. _platforms:
 
@@ -157,25 +151,9 @@ Ansible
 .. autoclass:: molecule.verifier.ansible.Ansible()
    :undoc-members:
 
-Lint
-....
-
-.. autoclass:: molecule.verifier.lint.ansible_lint.AnsibleLint()
-   :undoc-members:
 
 Testinfra
 ^^^^^^^^^
 
 .. autoclass:: molecule.verifier.testinfra.Testinfra()
    :undoc-members:
-
-.. _root_lint:
-
-Lint
-....
-
-.. autoclass:: molecule.verifier.lint.flake8.Flake8()
-   :undoc-members:
-
-.. autoclass:: molecule.verifier.lint.precommit.PreCommit()
-   :undoc-members:
diff --git a/molecule/command/init/role.py b/molecule/command/init/role.py
@@ -151,7 +151,5 @@ def role(
         'verifier_name': verifier_name,
     }
 
-    command_args['verifier_lint_name'] = api.verifiers()[verifier_name].default_linter
-
     r = Role(command_args)
     r.execute()
diff --git a/molecule/command/init/scenario.py b/molecule/command/init/scenario.py
@@ -227,8 +227,6 @@ def scenario(
         'verifier_name': verifier_name,
     }
 
-    command_args['verifier_lint_name'] = api.verifiers()[verifier_name].default_linter
-
     driver_template = driver_template or os.environ.get(
         'MOLECULE_SCENARIO_DRIVER_TEMPLATE', None
     )

diff --git a/molecule/command/lint.py b/molecule/command/lint.py
@@ -71,18 +71,7 @@ def execute(self):
         :return: None
         """
         self.print_info()
-        linters = [
-            l
-            for l in [
-                self._config.lint,
-                self._config.verifier.lint,
-                self._config.provisioner.lint,
-            ]
-            if l
-        ]
-
-        for l in linters:
-            l.execute()
+        # TODO: run linter
 
 
 @click.command()

diff --git a/molecule/config.py b/molecule/config.py
@@ -35,7 +35,6 @@
 from molecule.dependency import ansible_galaxy
 from molecule.dependency import gilt
 from molecule.dependency import shell
-from molecule.lint import yamllint
 from molecule.model import schema_v2
 from molecule.provisioner import ansible
 
@@ -181,21 +180,18 @@ def env(self):
             'MOLECULE_INSTANCE_CONFIG': self.driver.instance_config,
             'MOLECULE_DEPENDENCY_NAME': self.dependency.name,
             'MOLECULE_DRIVER_NAME': self.driver.name,
-            'MOLECULE_LINT_NAME': self.lint.name,
+            'MOLECULE_LINT_NAME': self.lint,
             'MOLECULE_PROVISIONER_NAME': self.provisioner.name,
-            'MOLECULE_PROVISIONER_LINT_NAME': self.provisioner.lint.name,
             'MOLECULE_SCENARIO_NAME': self.scenario.name,
             'MOLECULE_VERIFIER_NAME': self.verifier.name,
-            'MOLECULE_VERIFIER_LINT_NAME': self.verifier.lint.name,
             'MOLECULE_VERIFIER_TEST_DIRECTORY': self.verifier.directory,
         }
 
     @property
     @util.lru_cache()
     def lint(self):
         lint_name = self.config['lint']['name']
-        if lint_name == 'yamllint':
-            return yamllint.Yamllint(self)
+        return lint_name
 
     @property
     @util.lru_cache()
@@ -413,7 +409,6 @@ def _get_defaults(self):
                 'options': {},
                 'env': {},
                 'additional_files_or_dirs': [],
-                'lint': {'name': 'flake8', 'enabled': True, 'options': {}, 'env': {}},
             },
         }
 

diff --git a/molecule/cookiecutter/molecule/cookiecutter.json b/molecule/cookiecutter/molecule/cookiecutter.json
@@ -7,6 +7,5 @@
     "provisioner_lint_name": "ansible-lint",
     "scenario_name": "OVERRIDDEN",
     "role_name": "OVERRIDDEN",
-    "verifier_name": "OVERRIDDEN",
-    "verifier_lint_name": "flake8"
+    "verifier_name": "OVERRIDDEN"
 }
diff --git a/...le_name}}/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml b/...le_name}}/{{cookiecutter.molecule_directory}}/{{cookiecutter.scenario_name}}/molecule.yml
@@ -17,10 +17,5 @@ platforms:
 {%- endif %}
 provisioner:
   name: {{ cookiecutter.provisioner_name }}
-  lint:
-    name: {{ cookiecutter.provisioner_lint_name }}
-    enabled: false
 verifier:
   name: {{ cookiecutter.verifier_name }}
-  lint:
-    name: {{ cookiecutter.verifier_lint_name }}
diff --git a/molecule/model/schema_v2.py b/molecule/model/schema_v2.py
@@ -123,22 +123,6 @@ def pre_validate_base_schema(env, keep_string):
                     'molecule_env_var': True,
                     'allowed': api.verifiers(),
                 },
-                'lint': {
-                    'type': 'dict',
-                    'schema': {
-                        'name': {
-                            'type': 'string',
-                            'molecule_env_var': True,
-                            'allowed': [
-                                'flake8',
-                                'pre-commit',
-                                'rubocop',
-                                'yamllint',
-                                'ansible-lint',
-                            ],
-                        }
-                    },
-                },
             },
         },
     }

diff --git a/molecule/provisioner/base.py b/molecule/provisioner/base.py
@@ -21,9 +21,6 @@
 
 import abc
 
-from molecule.util import lru_cache
-from molecule.provisioner.lint import ansible_lint
-
 
 class Base(object):
     """Provisioner Base Class."""
@@ -66,10 +63,3 @@ def name(self):  # pragma: no cover
         :returns: str
         """
         pass
-
-    @property
-    @lru_cache()
-    def lint(self):
-        lint_name = self._config.config['provisioner']['lint']['name']
-        if lint_name == 'ansible-lint':
-            return ansible_lint.AnsibleLint(self._config)
diff --git a/molecule/provisioner/lint/__init__.py b/molecule/provisioner/lint/__init__.py
diff --git a/molecule/test/resources/molecule_docker.yml b/molecule/test/resources/molecule_docker.yml
@@ -10,11 +10,7 @@ platforms:
     image: ${TEST_BASE_IMAGE}
 provisioner:
   name: ansible
-  lint:
-    name: ansible-lint
 scenario:
   name: ansible-galaxy
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/cleanup/molecule/default/molecule.yml b/molecule/test/scenarios/cleanup/molecule/default/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -21,11 +19,7 @@ provisioner:
     create: ../../../../resources/playbooks/docker/create.yml
     destroy: ../../../../resources/playbooks/docker/destroy.yml
     cleanup: cleanup.yml
-  lint:
-    name: ansible-lint
 scenario:
   name: default
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/dependency/molecule/ansible-galaxy/molecule.yml b/molecule/test/scenarios/dependency/molecule/ansible-galaxy/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -20,11 +18,7 @@ provisioner:
   playbooks:
     create: ../../../../resources/playbooks/docker/create.yml
     destroy: ../../../../resources/playbooks/docker/destroy.yml
-  lint:
-    name: ansible-lint
 scenario:
   name: ansible-galaxy
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/dependency/molecule/gilt/molecule.yml b/molecule/test/scenarios/dependency/molecule/gilt/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -20,11 +18,7 @@ provisioner:
   playbooks:
     create: ../../../../resources/playbooks/docker/create.yml
     destroy: ../../../../resources/playbooks/docker/destroy.yml
-  lint:
-    name: ansible-lint
 scenario:
   name: gilt
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/dependency/molecule/shell/molecule.yml b/molecule/test/scenarios/dependency/molecule/shell/molecule.yml
@@ -6,8 +6,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -21,11 +19,7 @@ provisioner:
   playbooks:
     create: ../../../../resources/playbooks/docker/create.yml
     destroy: ../../../../resources/playbooks/docker/destroy.yml
-  lint:
-    name: ansible-lint
 scenario:
   name: shell
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/driver/docker/molecule/ansible-verifier/molecule.yml b/molecule/test/scenarios/driver/docker/molecule/ansible-verifier/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -21,11 +19,7 @@ provisioner:
     destroy: ../../../../../resources/playbooks/docker/destroy.yml
   env:
     ANSIBLE_ROLES_PATH: ../../../../../resources/roles/
-  lint:
-    name: ansible-lint
 scenario:
   name: ansible-verifier
 verifier:
   name: ansible
-  lint:
-    name: ansible-lint
diff --git a/molecule/test/scenarios/driver/docker/molecule/default/molecule.yml b/molecule/test/scenarios/driver/docker/molecule/default/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../../resources/.yamllint
 platforms:
   - name: instance
     image: ${TEST_BASE_IMAGE}
@@ -26,11 +24,7 @@ provisioner:
     ANSIBLE_ROLES_PATH: ../../../../../resources/roles/
     # keep this here to test that we convert integers to strings:
     SOME_VALUE_AS_INFO: 1
-  lint:
-    name: ansible-lint
 scenario:
   name: default
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/driver/docker/molecule/multi-node/molecule.yml b/molecule/test/scenarios/driver/docker/molecule/multi-node/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: docker
 lint:
   name: yamllint
-  options:
-    config-file: ../../../resources/.yamllint
 platforms:
   - name: instance-1
     image: ${TEST_BASE_IMAGE}
@@ -30,11 +28,7 @@ provisioner:
     destroy: ../../../../../resources/playbooks/docker/destroy.yml
   env:
     ANSIBLE_ROLES_PATH: ../../../../../resources/roles/
-  lint:
-    name: ansible-lint
 scenario:
   name: multi-node
 verifier:
   name: testinfra
-  lint:
-    name: flake8
diff --git a/molecule/test/scenarios/driver/podman/molecule/ansible-verifier/molecule.yml b/molecule/test/scenarios/driver/podman/molecule/ansible-verifier/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: podman
 lint:
   name: yamllint
-  options:
-    config-file: ../../../resources/.yamllint
 platforms:
   - name: instance
     image: centos:latest
@@ -24,11 +22,7 @@ provisioner:
     destroy: ../../../../../resources/playbooks/podman/destroy.yml
   env:
     ANSIBLE_ROLES_PATH: ../../../../../resources/roles/
-  lint:
-    name: ansible-lint
 scenario:
   name: ansible-verifier
 verifier:
   name: ansible
-  lint:
-    name: ansible-lint
diff --git a/molecule/test/scenarios/driver/podman/molecule/default/molecule.yml b/molecule/test/scenarios/driver/podman/molecule/default/molecule.yml
@@ -5,8 +5,6 @@ driver:
   name: podman
 lint:
   name: yamllint
-  options:
-    config-file: ../../../resources/.yamllint
 platforms:
   - name: instance
     image: centos:latest
@@ -26,11 +24,7 @@ provisioner:
     ANSIBLE_ROLES_PATH: ../../../../../resources/roles/
     # keep this here to test that we convert integers to strings:
     SOME_VALUE_AS_INFO: 1
-  lint:
-    name: ansible-lint
 scenario:
   name: default
 verifier:
   name: testinfra
-  lint:
-    name: flake8