Added sky-puppy-checker-template to tests and readme

Phara0h · Oct 30, 2020 · a927cdf · a927cdf
1 parent f3f8ee5
commit a927cdf
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 7 deletions.
diff --git a/README.nbs b/README.nbs
@@ -15,6 +15,15 @@ npm install -g sky-puppy
 sky-puppy
 ```
 
+## Checkers
+
+##### Test
+- [sky-puppy-checker-template](https://github.com/Phara0h/sky-puppy-checker-template) : A Sky Puppy template to use to create your own checkers
+
+##### HTTP/HTTPS
+- request (native)
+
+
 ## Sample Config
 
 Sky Puppy looks for a file called `sky-puppy-config.json` in the folder it is ran at.

diff --git a/package.json b/package.json
@@ -36,14 +36,15 @@
     "nstats": "^4.1.2"
   },
   "devDependencies": {
+    "auto-changelog": "^2.2.0",
     "eslint": "^7.8.1",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.4",
-    "prettier": "^2.0.5",
-    "prettier-eslint": "^11.0.0",
     "jsdoc-to-markdown": "^6.0.1",
-    "auto-changelog": "^2.2.0",
     "mdsquash": "^1.0.5",
-    "postgen": "^4.6.0"
+    "postgen": "^4.6.0",
+    "prettier": "^2.0.5",
+    "prettier-eslint": "^11.0.0",
+    "sky-puppy-checker-template": "^1.0.1"
   }
 }
diff --git a/test/sky-puppy-config.json b/test/sky-puppy-config.json
@@ -1,4 +1,10 @@
 {
+    "checkers": {
+        "request": {},
+        "sky-puppy-checker-template": {
+            "foo": "bar"
+        }
+    },
     "alerters": {
         "discord_down": {
             "uri": "http://127.0.0.1:4270/alert/test",
@@ -139,12 +145,34 @@
                     "alerter": "discord_healthy"
                 }
             ]
+        },
+        "sky-puppy-checker-template-test": {
+            "interval": 2,
+            "checker": {
+                "name": "sky-puppy-checker-template",
+                "settings": {
+                    "bar": "test"
+                }
+            },
+            "expected_response_time": 500,
+            "alerts": [
+                {
+                    "type": "down",
+                    "alerter": "discord_down"
+                },
+                {
+                    "type": "unhealthy_response_time",
+                    "for": 1,
+                    "alerter": "discord_unhealthy"
+                },
+                {
+                    "type": "healthy",
+                    "alerter": "discord_healthy"
+                }
+            ]
         }
     },
     "skypuppy": {
         "version": "1.0.0"
-    },
-    "checkers": {
-        "request": {}
     }
 }