Merge pull request #1 from Akinari1087/master

Add Unit Test Rules Hook

.pre-commit-hooks.yaml

@@ -19,3 +19,14 @@
   args:
   - check
   - rules
+
+- id: test-rules
+  stages: [commit]
+  name: Unit test prometheus rule files
+  description: Unit test prometheus rule files
+  language: docker_image
+  entry: --entrypoint /bin/promtool prom/prometheus:latest
+  files: ^$
+  args:
+  - test
+  - rules

README.md

@@ -29,3 +29,18 @@ To lint Prometheus Config files, use the `prometheus-config` hook.  Make sure to
           (?x)^(
             config_directory/.*\.yml
           )$
+
+To unit-test Prometheus Rule files, use the `test-rules` hook.  Make sure to filter files passed to hook by defining the `files` section.  Note: the `entry` option below is optional and will default to the latest prometheus version.  It is shown just as an example of pinning to a specific prometheus version.
+
+In the example provided, we are setting this to always run as rule files could be changed without altering the unit tests.  Unit tests should be run against their respective rule files after any change.
+
+    - repo: https://github.com/fortman/pre-commit-prometheus
+      rev: v1.2.0
+      hooks:
+      - id: test-rules
+        entry: --entrypoint /bin/promtool prom/prometheus:v2.18.2
+        always_run: true
+        files: >
+          (?x)^(
+            unit_test_directory/.*\.yml
+          )$