Switch to Node and add Readme

Author: toolmantim

Diff for: .gitignore

@@ -0,0 +1 @@
+/node_modules

Diff for: Dockerfile

@@ -1,5 +1,6 @@
-FROM       ruby:2.5.1-alpine
-RUN        gem install json-schema
+FROM       node:9-alpine
 WORKDIR    /src
-ADD        example-validator.rb .
-ENTRYPOINT ["ruby", "example-validator.rb"]
+ADD        index.js package.json package-lock.json /src/
+ENV        NODE_ENV=production
+RUN        npm -s install
+ENTRYPOINT ["node", "index.js"]

Diff for: LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Buildkite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

Diff for: README.md

@@ -0,0 +1,26 @@
+# Buildkite Plugin Example Validator
+
+A tool for validating a [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugin)’s readme examples against its JSON schema file.
+
+## Usage
+
+In a plugin’s pipeline.yml test suite:
+
+```yaml
+  - label: ":json:"
+    command: /plugin/schema.yml /plugin/README.md
+    plugins:
+      docker#x.x.x:
+        image: buildkite/plugin-example-validator
+        workdir: /plugin
+```
+
+On the command line:
+
+```bash
+docker run -it --rm -v "$(pwd):/plugin" buildkite/plugin-example-validator /plugin/schema.yml /plugin/README.md
+```
+
+## License
+
+MIT (see [LICENSE](LICENSE))

Diff for: example-validator.rb

@@ -0,0 +1,68 @@
+const fs = require('fs')
+const Ajv = require('ajv')
+const yaml = require('js-yaml')
+
+const pluginName = process.argv[2]
+const schemaPath = process.argv[3]
+const readmePath = process.argv[4]
+
+if (!pluginName || !schemaPath || !readmePath) {
+  throw "Usage: <plugin-name> <schema-path> <readme-path>"
+}
+
+const readme = fs.readFileSync(readmePath, 'utf8')
+const schema = yaml.safeLoad(fs.readFileSync(schemaPath, 'utf8'))
+const ajv = new Ajv({ allErrors: true, jsonPointers: true })
+const validator = ajv.compile(schema)
+
+const pluginConfigKeyPattern = new RegExp(`^${pluginName}#v.*$`)
+
+const pluginConfigs = []
+
+extractPipelineExamples()
+  .forEach((example) => {
+    extractPluginConfigs(example)
+      .forEach((config) => {
+        pluginConfigs.push(config)
+        validateConfig(example, config)
+      })
+  })
+
+function extractPipelineExamples() {
+  const examples = []
+  const yamlPattern = /```yml\n+(.*?)\n+```/gs
+  while (yamlMatch = yamlPattern.exec(readme)) {
+    examples.push(yamlMatch[1])
+  }
+  return examples 
+}
+
+function extractPluginConfigs(exampleYaml) {
+  const configs = []
+  const example = yaml.safeLoad(exampleYaml)
+  if (example.steps) {
+    example.steps.forEach((step) => {
+      if (step.plugins) {
+        Object.entries(step.plugins).forEach(([ name, config ]) => {
+          if (pluginConfigKeyPattern.exec(name)) {
+            configs.push(config)
+          }
+        })
+      }
+    })
+  }
+  return configs
+}
+
+function validateConfig(fullExample, pluginConfig) {
+  if (!validator(pluginConfig)) {
+    console.log("🚨 Example is invalid:")
+    console.log(fullExample)
+    console.log(validator.errors)
+    process.exitCode = 1
+  }
+}
+
+if (process.exitCode != 1) {
+  console.log(`🙌 All ${pluginConfigs.length} plugin examples are valid`)
+}