From 1eba958f2565232be58bbc6dba613b1612a2525d Mon Sep 17 00:00:00 2001
From: Tapan Chudasama <tapan9740@gmail.com>
Date: Thu, 1 Apr 2021 23:57:54 +0530
Subject: [PATCH] [REUSE] Add service badges (#6330)

* feat/REUSE compliance

Co-authored-by: chris48s <chris48s@users.noreply.github.com>
---
 services/reuse/reuse-compliance-helper.js  | 19 ++++++
 services/reuse/reuse-compliance.service.js | 55 +++++++++++++++++
 services/reuse/reuse-compliance.tester.js  | 69 ++++++++++++++++++++++
 3 files changed, 143 insertions(+)
 create mode 100644 services/reuse/reuse-compliance-helper.js
 create mode 100644 services/reuse/reuse-compliance.service.js
 create mode 100644 services/reuse/reuse-compliance.tester.js

diff --git a/services/reuse/reuse-compliance-helper.js b/services/reuse/reuse-compliance-helper.js
new file mode 100644
index 0000000000..bb25653fdf
--- /dev/null
+++ b/services/reuse/reuse-compliance-helper.js
@@ -0,0 +1,19 @@
+'use strict'
+
+const Joi = require('joi')
+
+const COLOR_MAP = {
+  checking: 'brightgreen',
+  compliant: 'green',
+  'non-compliant': 'red',
+  unregistered: 'red',
+}
+
+const isReuseCompliance = Joi.string()
+  .valid('compliant', 'non-compliant', 'checking', 'unregistered')
+  .required()
+
+module.exports = {
+  isReuseCompliance,
+  COLOR_MAP,
+}
diff --git a/services/reuse/reuse-compliance.service.js b/services/reuse/reuse-compliance.service.js
new file mode 100644
index 0000000000..c33fb3b2f5
--- /dev/null
+++ b/services/reuse/reuse-compliance.service.js
@@ -0,0 +1,55 @@
+'use strict'
+const Joi = require('joi')
+const { BaseJsonService } = require('..')
+const { isReuseCompliance, COLOR_MAP } = require('./reuse-compliance-helper')
+
+const responseSchema = Joi.object({
+  status: isReuseCompliance,
+}).required()
+
+module.exports = class Reuse extends BaseJsonService {
+  static category = 'license'
+
+  static route = {
+    base: 'reuse/compliance',
+    pattern: ':remote+',
+  }
+
+  static examples = [
+    {
+      title: 'REUSE Compliance',
+      namedParams: {
+        remote: 'github.com/fsfe/reuse-tool',
+      },
+      staticPreview: this.render({ status: 'compliant' }),
+      keywords: ['license'],
+    },
+  ]
+
+  static defaultBadgeData = {
+    label: 'reuse',
+  }
+
+  static render({ status }) {
+    return {
+      label: 'reuse',
+      message: status,
+      color: COLOR_MAP[status],
+    }
+  }
+
+  async fetch({ remote }) {
+    return await this._requestJson({
+      schema: responseSchema,
+      url: `https://api.reuse.software/status/${remote}`,
+      errorMessages: {
+        400: 'Not a Git repository',
+      },
+    })
+  }
+
+  async handle({ remote }) {
+    const { status } = await this.fetch({ remote })
+    return this.constructor.render({ status })
+  }
+}
diff --git a/services/reuse/reuse-compliance.tester.js b/services/reuse/reuse-compliance.tester.js
new file mode 100644
index 0000000000..a160e66107
--- /dev/null
+++ b/services/reuse/reuse-compliance.tester.js
@@ -0,0 +1,69 @@
+'use strict'
+
+const t = (module.exports = require('../tester').createServiceTester())
+const { isReuseCompliance, COLOR_MAP } = require('./reuse-compliance-helper')
+
+t.create('valid repo -- live')
+  .get('/github.com/fsfe/reuse-tool.json')
+  .expectBadge({
+    label: 'reuse',
+    message: isReuseCompliance,
+    color: COLOR_MAP[isReuseCompliance],
+  })
+
+t.create('valid repo -- compliant')
+  .get('/github.com/username/repo.json')
+  .intercept(nock =>
+    nock('https://api.reuse.software/status')
+      .get('/github.com/username/repo')
+      .reply(200, { status: 'compliant' })
+  )
+  .expectBadge({
+    label: 'reuse',
+    message: 'compliant',
+    color: COLOR_MAP.compliant,
+  })
+
+t.create('valid repo -- non-compliant')
+  .get('/github.com/username/repo.json')
+  .intercept(nock =>
+    nock('https://api.reuse.software/status')
+      .get('/github.com/username/repo')
+      .reply(200, { status: 'non-compliant' })
+  )
+  .expectBadge({
+    label: 'reuse',
+    message: 'non-compliant',
+    color: COLOR_MAP['non-compliant'],
+  })
+
+t.create('valid repo -- checking')
+  .get('/github.com/username/repo.json')
+  .intercept(nock =>
+    nock('https://api.reuse.software/status')
+      .get('/github.com/username/repo')
+      .reply(200, { status: 'checking' })
+  )
+  .expectBadge({
+    label: 'reuse',
+    message: 'checking',
+    color: COLOR_MAP.checking,
+  })
+
+t.create('valid repo -- unregistered')
+  .get('/github.com/username/repo.json')
+  .intercept(nock =>
+    nock('https://api.reuse.software/status')
+      .get('/github.com/username/repo')
+      .reply(200, { status: 'unregistered' })
+  )
+  .expectBadge({
+    label: 'reuse',
+    message: 'unregistered',
+    color: COLOR_MAP.unregistered,
+  })
+
+t.create('invalid repo').get('/github.com/repo/invalid-repo.json').expectBadge({
+  label: 'reuse',
+  message: 'Not a Git repository',
+})