fix: add yamllint (#1032)

fix: add validation of profiles and groups configuration
splunk · Jul 1, 2024 · 9895687 · 9895687
1 parent 70f498a
commit 9895687
Show file tree

Hide file tree

Showing 15 changed files with 602 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@
 - while mounting volumes in docker compose explicitly mount them as read only or read write
 - added `values.yaml` schema validation using `values.schema.json`
 - released beta version of improved polling performance
+- added `yamllint` validation for the `values.yaml` formatting
+- added "in code" validation of groups and profiles
 
 ### Fixed
 - fixed a bug with configuration from values.yaml not being transferred to the UI while migrating to SC4SNMP-UI

diff --git a/charts/splunk-connect-for-snmp/values.yaml b/charts/splunk-connect-for-snmp/values.yaml
@@ -86,7 +86,7 @@ splunk:
 
   # name of the metrics index
   metricsIndex: "netmetrics"
-  
+
 ################################################################################
 # Splunk Observability configuration
 ################################################################################
@@ -97,7 +97,7 @@ sim:
 
   # Splunk Observability realm to send telemetry data to.
   signalfxToken: ""
-  # Required for Splunk Observability (if `realm` is specified). 
+  # Required for Splunk Observability (if `realm` is specified).
   # Splunk Observability org access token.
   signalfxRealm: ""
 
@@ -383,7 +383,7 @@ inventory:
     name: ""
 
   service:
-    annotations: { }
+    annotations: {}
 
   # set CPU and Memory limits for an inventory pod
   resources: {}

diff --git a/docs/bestpractices.md b/docs/bestpractices.md
@@ -153,6 +153,17 @@ microk8s kubectl delete job/snmp-splunk-connect-for-snmp-inventory -n sc4snmp
 ```
 The upgrade command can be executed again. 
 
+### "The following profiles have invalid configuration" or "The following groups have invalid configuration" errors
+Following errors are examples of wrong configuration:
+```
+The following groups have invalid configuration and won't be used: ['group1']. Please check indentation and keywords spelling inside mentioned groups configuration.
+```
+```
+The following profiles have invalid configuration and won't be used: ['standard_profile', 'walk_profile']. Please check indentation and keywords spelling inside mentioned profiles configuration.
+```
+Errors above indicate, that the mentioned groups or profiles might have wrong indentation or some keywords were omitted or misspelled. Refer to [Configuring profiles](./configuration/configuring-profiles.md)
+or [Configuring Groups](./configuration/configuring-groups.md) sections to check how the correct configuration should look like.
+
 ### Identifying Traps issues
 
 #### Wrong IP or port

diff --git a/docs/gettingstarted/sc4snmp-installation.md b/docs/gettingstarted/sc4snmp-installation.md
@@ -42,6 +42,22 @@ or download it directly from Helm using the command `microk8s helm3 show values
 
 It is recommended to start by completing the base template and gradually add additional configurations as needed.
 
+
+The `values.yaml` file is validated using `JSON schema` built into `helm chart` and inside the code.
+To ensure that your `values.yaml` follows formatting standards, you can use `yamllint`. In order to download
+`yamllint` refer to the [installation instructions](https://yamllint.readthedocs.io/en/stable/quickstart.html#installing-yamllint). 
+Then create `custom-config.yamllint` file and add the following configuration:
+```yaml
+extends: default
+
+rules:
+  line-length:
+    max: 80
+    level: warning
+```
+Configuration above can be found in the `examples` directory in SC4SNMP [GitHub repository](https://github.com/splunk/splunk-connect-for-snmp).
+Next run `yamllint -c <path to custom-config.yamllint> <path to values.yaml>` command. Warnings can be ignored.
+
 #### Install SC4SNMP
 
 After the `values.yaml` creation, you can proceed with the SC4SNMP installation:

diff --git a/examples/custom-config.yamllint b/examples/custom-config.yamllint
@@ -0,0 +1,6 @@
+extends: default
+
+rules:
+  line-length:
+    max: 80
+    level: warning
diff --git a/examples/lightweight_installation.yaml b/examples/lightweight_installation.yaml
@@ -14,12 +14,12 @@ traps:
       - homelab
   replicaCount: 1
   resources:
-     limits:
-       cpu: 100m
-       memory: 300Mi
-     requests:
-       cpu: 40m
-       memory: 256Mi
+    limits:
+      cpu: 100m
+      memory: 300Mi
+    requests:
+      cpu: 40m
+      memory: 256Mi
   #loadBalancerIP: The IP address in the metallb pool
   loadBalancerIP: ###TRAP_RECEIVER_IP###
 worker:
@@ -54,12 +54,12 @@ worker:
 scheduler:
   logLevel: "INFO"
   resources:
-     limits:
-       cpu: 40m
-       memory: 260Mi
-     requests:
-       cpu: 20m
-       memory: 180Mi
+    limits:
+      cpu: 40m
+      memory: 260Mi
+    requests:
+      cpu: 20m
+      memory: 180Mi
   profiles: |
     generic_switch:
       frequency: 300
@@ -80,8 +80,8 @@ poller:
     10.0.0.100,,3,,sc4snmp-hlab-sha-des,,1800,generic_switch,,
 inventory:
   resources:
-     limits:
-       cpu: 60m
-       memory: 300Mi
-     requests:
-       cpu: 20m
+    limits:
+      cpu: 60m
+      memory: 300Mi
+    requests:
+      cpu: 20m
diff --git a/examples/o11y_values.yaml b/examples/o11y_values.yaml
@@ -42,4 +42,4 @@ poller:
   inventory: |
     address,port,version,community,secret,security_engine,walk_interval,profiles,smart_profiles,delete
     54.82.4.248,,2c,public,,,4000,small_walk;IF_profile;ICMP_profile,,
-    54.82.4.249,,2c,public,,,1800,small_walk;IF_profile,,
+    54.82.4.249,,2c,public,,,1800,small_walk;IF_profile,,
diff --git a/examples/polling_and_traps_v3.yaml b/examples/polling_and_traps_v3.yaml
@@ -28,4 +28,4 @@ poller:
     - sc4snmp-hlab-sha-aes
   inventory: |
     address,port,version,community,secret,security_engine,walk_interval,profiles,smart_profiles,delete
-    54.82.4.248,,3,public,sc4snmp-hlab-sha-aes,,2000,switch_profile,,
+    54.82.4.248,,3,public,sc4snmp-hlab-sha-aes,,2000,switch_profile,,
diff --git a/examples/polling_groups_values.yaml b/examples/polling_groups_values.yaml
@@ -22,4 +22,4 @@ scheduler:
 poller:
   inventory: |
     address,port,version,community,secret,security_engine,walk_interval,profiles,smart_profiles,delete
-    switch_group,,2c,public,,,2000,switch_profile,,
+    switch_group,,2c,public,,,2000,switch_profile,,
diff --git a/examples/polling_values.yaml b/examples/polling_values.yaml
@@ -49,4 +49,4 @@ poller:
   inventory: |
     address,port,version,community,secret,security_engine,walk_interval,profiles,smart_profiles,delete
     54.82.4.248,,2c,public,,,4000,small_walk;IF_profile;ICMP_profile,,
-    54.82.4.249,,2c,public,,,1800,small_walk;IF_profile,,
+    54.82.4.249,,2c,public,,,1800,small_walk;IF_profile,,
diff --git a/integration_tests/test_poller_integration.py b/integration_tests/test_poller_integration.py
@@ -1268,6 +1268,148 @@ def test_wrong_profiles(self, request, setup_splunk):
         assert metric_count == 0
 
 
+@pytest.fixture(scope="class")
+def setup_misconfigured_profiles(request):
+    """
+    None of the profiles below should poll anything.
+    """
+    trap_external_ip = request.config.getoption("trap_external_ip")
+    profiles = {
+        "no_varbinds_profile": {
+            "frequency": 7,
+            "varBinds": [],
+            "conditions": [
+                {"field": "IF-MIB.ifIndex", "operation": dq("gt"), "value": 20},
+                {
+                    "field": "IF-MIB.ifDescr",
+                    "operation": dq("equals"),
+                    "value": dq("eth0"),
+                },
+            ],
+        },
+        "no_operation_key_in_condition_profile": {
+            "frequency": 7,
+            "varBinds": [yaml_escape_list(sq("IF-MIB"), sq("ifOutDiscards"))],
+            "conditions": [
+                {"field": "IF-MIB.ifIndex", "operation": dq("lt"), "value": 20},
+                {
+                    "field": "IF-MIB.ifDescr",
+                    "value": [dq("test value 1"), dq("test value 2")],
+                },
+            ],
+        },
+        "no_frequency_profile": {
+            "varBinds": [yaml_escape_list(sq("IF-MIB"), sq("ifOutDiscards"))],
+            "conditions": [
+                {"field": "IF-MIB.ifIndex", "operation": dq("equals"), "value": 200}
+            ],
+        },
+        "no_patterns_profile": {
+            "frequency": 3,
+            "condition": {
+                "type": "field",
+                "field": "SNMPv2-MIB.sysDescr",
+            },
+            "varBinds": [
+                yaml_escape_list(sq("IP-MIB"), sq("icmpOutDestUnreachs"), 0),
+                yaml_escape_list(sq("IP-MIB"), sq("icmpOutEchoReps"), 0),
+            ],
+        },
+    }
+
+    update_profiles(profiles)
+    update_file(
+        [
+            f"{trap_external_ip},1165,2c,public,,,600,no_varbinds_profile;no_operation_key_in_condition_profile;no_frequency_profile;no_patterns_profile,,",
+        ],
+        "inventory.yaml",
+    )
+    upgrade_helm(["inventory.yaml", "profiles.yaml"])
+    time.sleep(120)
+    yield
+    update_file(
+        [
+            f"{trap_external_ip},1165,2c,public,,,600,no_varbinds_profile;no_operation_key_in_condition_profile;no_frequency_profile;no_patterns_profile,,t",
+        ],
+        "inventory.yaml",
+    )
+    upgrade_helm(["inventory.yaml"])
+    time.sleep(120)
+
+
+@pytest.mark.usefixtures("setup_misconfigured_profiles")
+class TestMisconfiguredProfiles:
+    def test_wrong_profiles(self, request, setup_splunk):
+        time.sleep(20)
+        search_string = """| mpreview index=netmetrics | search profiles=no_varbinds_profile OR profiles=no_operation_key_in_condition_profile OR profiles=no_frequency_profile OR profiles=no_patterns_profile """
+        result_count, metric_count = run_retried_single_search(
+            setup_splunk, search_string, 2
+        )
+        assert result_count == 0
+        assert metric_count == 0
+
+
+@pytest.fixture(scope="class")
+def setup_misconfigured_groups(request):
+    trap_external_ip = request.config.getoption("trap_external_ip")
+    profiles = {
+        "routers_wrong_group_profile": {
+            "frequency": 7,
+            "varBinds": [yaml_escape_list(sq("IP-MIB"))],
+        },
+        "switches_wrong_group_profile": {
+            "frequency": 7,
+            "varBinds": [yaml_escape_list(sq("IP-MIB"))],
+        },
+    }
+    groups = {
+        "routers": [
+            {"address": trap_external_ip, "port": 1163},
+            {"address": trap_external_ip, "port": 1164, "wrong_key": 1},
+        ],
+        "switches": [
+            {"addre": trap_external_ip},
+            {"address": trap_external_ip, "port": 1162},
+        ],
+    }
+
+    update_profiles(profiles)
+    update_groups(groups)
+    update_file(
+        [
+            f"{trap_external_ip},1165,2c,public,,,600,single_profile,,",
+            f"routers,,2c,public,,,600,routers_wrong_group_profile,,",
+            f"switches,,2c,public,,,600,switches_wrong_group_profile,,",
+        ],
+        "inventory.yaml",
+    )
+    upgrade_helm(["inventory.yaml", "profiles.yaml", "groups.yaml"])
+    time.sleep(120)
+    yield
+    update_file(
+        [
+            f"{trap_external_ip},1165,2c,public,,,600,single_profile,,t",
+            f"routers,,2c,public,,,600,routers_wrong_group_profile,,t",
+            f"switches,,2c,public,,,600,switches_wrong_group_profile,,t",
+        ],
+        "inventory.yaml",
+    )
+    upgrade_helm(["inventory.yaml"])
+    time.sleep(100)
+
+
+@pytest.mark.usefixtures("setup_misconfigured_groups")
+class TestMisconfiguredGroups:
+    def test_wrong_groups(self, request, setup_splunk):
+        time.sleep(20)
+        search_string = """| mpreview index=netmetrics | search profiles=routers_wrong_group_profile OR profiles=routers_wrong_group_profile """
+        result_count, metric_count = run_retried_single_search(
+            setup_splunk, search_string, 2
+        )
+        assert result_count == 0
+        assert metric_count == 0
+
+
 def run_retried_single_search(setup_splunk, search_string, retries):
     for _ in range(retries):
         result_count, metric_count = splunk_single_search(setup_splunk, search_string)