screwdriver-api 7.0.252 → 7.0.254

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.252",
+  "version": "7.0.254",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
     "pretest": "eslint . --quiet",
     "test": "nyc --report-dir ./artifacts/coverage --reporter=lcov mocha --reporter mocha-multi-reporters --reporter-options configFile=./mocha.config.json --recursive --timeout 10000 --retries 1 --exit --allow-uncaught true --color true",
     "test-debug": "mocha --inspect-brk ./test/**/*.js",
+    "test-banner": "mocha ./test/**/banner.test.js",
     "start": "./bin/server",
     "debug": "node --nolazy ./bin/server",
     "profile": "node --prof ./bin/server",
     "functional": "cucumber-js --format=progress --tags '(not @ignore) and @prod' --retry 2 --fail-fast --exit",
+    "functional-banner": "cucumber-js --format=progress --tags '(not @ignore) and (not @prod) and @banner' --fail-fast --exit",
     "functional-beta": "cucumber-js --format=progress --tags '(not @ignore) and (not @prod) and (not @x1) and (not @parallel)' --retry 2 --fail-fast --exit",
     "functional-beta-parallel": "cucumber-js --format=progress --tags '(not @ignore) and (not @prod) and (not @x1) and @parallel' --retry 2 --fail-fast --exit --parallel 4",
     "functional-beta-x1-parallel": "cucumber-js --format=progress --tags '(not @ignore) and (not @prod) and @x1 and @parallel' --retry 2 --fail-fast --exit --parallel 4",

package/plugins/banners/README.md

@@ -36,20 +36,37 @@ server.register({
 * `message` - Text of the banner to create.
 * `type` - An optional banner type. Options are `info` and `warn`. Defaults to `info`
 * `isActive` - An optional status flag to indicate whether banner should display.  Defaults to `false`
+* `scope` - An optional scope type that specifies whether the banner should be displayed globally or limited to the affected pipelines or builds. Accepted values are `GLOBAL`, `PIPELINE`, and `BUILD`, with `GLOBAL` as the default.
+* `scopeId` - A required field when the scope is set to `PIPELINE` or `BUILD`, serving as a reference to the corresponding pipeline or build ID.
 
 Example payload:
 ```json
 {
     "message": "The Screwdriver Team is currently investigating random failures.",
     "type": "info",
-    "isActive": "true"
+    "isActive": "true",
+    "scope": "PIPELINE",
+    "scopeId": "12345"
 }
 ```
 
 #### Get a listing of all banners
 
+Query Params:
+
+* `scope` - *Optional* Returns banners for a specific scope
+* `scopeId` - *Optional* Filters by a specific scope ID
+* `createdBy` - *Optional* Filters banners created by a specific user
+* `type` - *Optional* Filters by banner type
+* `isActive` - *Optional* Accepts true or false to filter active or inactive banners
+
 `GET /banners`
 
+`GET /banners?scope=GLOBAL&isActive=true&type=info`
+
+`GET /banners?scope=PIPELINE&scopeId=12345&isActive=true&type=info`
+
+
 #### Get a specific banner
 
 `GET /banners/{id}`

package/plugins/banners/get.js

@@ -18,6 +18,11 @@ module.exports = () => ({
                 enabled: false
             }
         },
+        auth: {
+            strategies: ['token'],
+            scope: ['user'],
+            mode: 'try' // This allows unauthenticated requests but still runs the auth check
+        },
         handler: async (request, h) => {
             const { bannerFactory } = request.server.app;
             const { id } = request.params;
@@ -28,6 +33,11 @@ module.exports = () => ({
                     if (!banner) {
                         throw boom.notFound(`Banner ${id} does not exist`);
                     }
+                    if (banner.scope !== 'GLOBAL') {
+                        if (!request.auth.isAuthenticated) {
+                            throw boom.unauthorized('Authentication required');
+                        }
+                    }
 
                     return h.response(banner.toJson());
                 })

package/plugins/banners/list.js

@@ -2,6 +2,7 @@
 
 const schema = require('screwdriver-data-schema');
 const listSchema = schema.models.banner.list;
+const boom = require('@hapi/boom');
 
 module.exports = () => ({
     method: 'GET',
@@ -10,6 +11,11 @@ module.exports = () => ({
         description: 'Get banners',
         notes: 'Returns all banner records',
         tags: ['api', 'banners'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user'],
+            mode: 'try' // This allows unauthenticated requests but still runs the auth check
+        },
         plugins: {
             'hapi-rate-limit': {
                 enabled: false
@@ -17,6 +23,13 @@ module.exports = () => ({
         },
         handler: async (request, h) => {
             const { bannerFactory } = request.server.app;
+            const { scope } = request.query;
+
+            if (scope !== 'GLOBAL') {
+                if (!request.auth.isAuthenticated) {
+                    throw boom.unauthorized('Authentication required');
+                }
+            }
 
             // list params defaults to empty object in models if undefined
             return bannerFactory