Add new deprecation functionality

saltlint/linter/rule.py

@@ -7,6 +7,7 @@
 
 from saltlint.utils import get_rule_skips_from_line, get_file_type
 from saltlint.linter.match import Match
+from saltlint.utils import LANGUAGE_SLS
 
 
 class Rule(object):
@@ -86,3 +87,32 @@ def matchfulltext(self, file, text):
             matches.append(Match(line, section, file['path'], self, message))
 
         return matches
+
+
+class DeprecationRule(Rule):
+    id = None
+    state = None
+    deprecated_since = None
+
+    severity = 'HIGH'
+    languages = [LANGUAGE_SLS]
+    tags = ['deprecation']
+
+    @property
+    def shortdesc(self):
+        return "State '{}' is deprecated since SaltStack version '{}'".format(
+            self.state, self.deprecated_since
+        )
+
+    @property
+    def description(self):
+        return self.shortdesc
+
+    @property
+    def regex(self):
+        return re.compile(
+            r"^\s{2}" + self.state.replace(".", r"\.") + "(?=:|$)"
+        )
+
+    def match(self, file, line):
+        return self.regex.search(line)

saltlint/rules/CmdWaitRecommendRule.py

@@ -2,11 +2,11 @@
 # Copyright (c) 2020 Warpnet B.V.
 
 import re
-from saltlint.linter.rule import Rule
+from saltlint.linter.rule import DeprecationRule
 from saltlint.utils import LANGUAGE_SLS
 
 
-class CmdWaitRecommendRule(Rule):
+class CmdWaitRecommendRule(DeprecationRule):
     id = '213'
     shortdesc = 'SaltStack recommends using cmd.run together with onchanges, rather than cmd.wait'
     description = 'SaltStack recommends using cmd.run together with onchanges, rather than cmd.wait'

saltlint/rules/StateDeprecationDockerAbsent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerAbsent(DeprecationRule):
+    id = '906'
+    state = 'docker.absent'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerImageAbsent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerImageAbsent(DeprecationRule):
+    id = '907'
+    state = 'docker.image_absent'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerImagePresent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerImagePresent(DeprecationRule):
+    id = '908'
+    state = 'docker.image_present'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerModWatch.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerModWatch(DeprecationRule):
+    id = '909'
+    state = 'docker.mod_watch'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerNetworkAbsent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerNetworkAbsent(DeprecationRule):
+    id = '910'
+    state = 'docker.network_absent'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerNetworkPresent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerNetworkPresent(DeprecationRule):
+    id = '911'
+    state = 'docker.network_present'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerRunning.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerRunning(DeprecationRule):
+    id = '912'
+    state = 'docker.running'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerStopped.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerStopped(DeprecationRule):
+    id = '913'
+    state = 'docker.stopped'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerVolumeAbsent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerVolumeAbsent(DeprecationRule):
+    id = '914'
+    state = 'docker.volume_absent'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationDockerVolumePresent.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationDockerVolumePresent(DeprecationRule):
+    id = '915'
+    state = 'docker.volume_present'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationElasticsearchIndexRule.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationElasticsearchIndexRule(DeprecationRule):
+    id = '902'
+    state = 'elasticsearch_index.absent'
+    deprecated_since = '2017.7.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationVirtRevertedRule.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationVirtRevertedRule(DeprecationRule):
+    id = '903'
+    state = 'virt.reverted'
+    deprecated_since = '2016.3.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationVirtSavedRule.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationVirtSavedRule(DeprecationRule):
+    id = '904'
+    state = 'virt.saved'
+    deprecated_since = '2016.3.0'
+    version_added = 'develop'

saltlint/rules/StateDeprecationVirtUnpoweredRule.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+from saltlint.linter.rule import DeprecationRule
+
+
+class StateDeprecationVirtUnpoweredRule(DeprecationRule):
+    id = '905'
+    state = 'virt.unpowered'
+    deprecated_since = '2016.3.0'
+    version_added = 'develop'

tests/unit/TestDeprecationRule.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2020 Warpnet B.V.
+
+import unittest
+
+from saltlint.linter.collection import RulesCollection
+from saltlint.rules.StateDeprecationDockerAbsent import StateDeprecationDockerAbsent
+from tests import RunFromText
+
+
+GOOD_STATES_LINE = '''
+example:
+  docker_container.absent:
+    - name: example
+
+example:
+  docker_container.absent
+'''
+
+BAD_STATES_LINE = '''
+example:
+  docker.absent:
+    - name: example
+
+example:
+  docker.absent
+'''
+
+class TestFileModeLeadingZeroRule(unittest.TestCase):
+    collection = RulesCollection()
+
+    def setUp(self):
+        self.collection.register(StateDeprecationDockerAbsent())
+
+    def test_statement_positive(self):
+        runner = RunFromText(self.collection)
+        results = runner.run_state(GOOD_STATES_LINE)
+        self.assertEqual(0, len(results))
+
+    def test_statement_negative(self):
+        runner = RunFromText(self.collection)
+        results = runner.run_state(BAD_STATES_LINE)
+        self.assertEqual(2, len(results))