DF-1293 #comment #resolved Added implements_access_list config option for overriding swagger def for role service access

Author: Lee Hicks

CHANGELOG.md

@@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- DF-1293 Added implements_access_list config option for overriding swagger def for role service access
 ### Fixed
 - DF-1287 Fixed NodeJS (and Python) script execution for large script. Made script size configurable
 - DF-1293 Fixed role service access components when swagger def is supplied

database/migrations/2017_08_29_203705_update_script_tables_for_service_linking.php

@@ -19,7 +19,7 @@ public function up()
         // so set the default no action and clear out created/modified by another user when deleting a user.
         $onDelete = (('sqlsrv' === $driver) ? 'no action' : 'set null');
 
-        if(Schema::hasTable('script_config') && !Schema::hasColumn('script_config', 'storage_service_id')){
+        if (Schema::hasTable('script_config') && !Schema::hasColumn('script_config', 'storage_service_id')) {
             Schema::table('script_config', function (Blueprint $t) use ($onDelete) {
                 $t->string('scm_reference')->nullable()->after('config');
                 $t->string('scm_repository')->nullable()->after('config');
@@ -29,7 +29,7 @@ public function up()
             });
         }
 
-        if(Schema::hasTable('event_script') && !Schema::hasColumn('event_script', 'storage_service_id')){
+        if (Schema::hasTable('event_script') && !Schema::hasColumn('event_script', 'storage_service_id')) {
             Schema::table('event_script', function (Blueprint $t) use ($onDelete) {
                 $t->string('scm_reference')->nullable()->after('config');
                 $t->string('scm_repository')->nullable()->after('config');
@@ -47,19 +47,21 @@ public function up()
      */
     public function down()
     {
-        if(Schema::hasTable('script_config') && Schema::hasColumn('script_config', 'storage_service_id')) {
-            Schema::table('script_config', function (Blueprint $t){
+        if (Schema::hasTable('script_config') && Schema::hasColumn('script_config', 'storage_service_id')) {
+            Schema::table('script_config', function (Blueprint $t) {
                 $t->dropColumn('storage_service_id');
                 $t->dropColumn('storage_path');
                 $t->dropColumn('scm_reference');
+                $t->dropColumn('scm_repository');
             });
         }
 
-        if(Schema::hasTable('event_script') && Schema::hasColumn('event_script', 'storage_service_id')) {
-            Schema::table('event_script', function (Blueprint $t){
+        if (Schema::hasTable('event_script') && Schema::hasColumn('event_script', 'storage_service_id')) {
+            Schema::table('event_script', function (Blueprint $t) {
                 $t->dropColumn('storage_service_id');
                 $t->dropColumn('storage_path');
                 $t->dropColumn('scm_reference');
+                $t->dropColumn('scm_repository');
             });
         }
     }

database/migrations/2018_01_23_155210_script_implements_access_list.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class ScriptImplementsAccessList extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('script_config', function (Blueprint $table) {
+            $table->boolean('implements_access_list')->default(0)->after('queued');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('script_config', function (Blueprint $table) {
+            $table->dropColumn('implements_access_list');
+        });
+    }
+}

src/Models/ScriptConfig.php

@@ -27,17 +27,19 @@ class ScriptConfig extends BaseServiceConfigModel
         'storage_service_id',
         'scm_reference',
         'scm_repository',
-        'storage_path'
+        'storage_path',
+        'implements_access_list',
     ];
 
     // deprecated, service has type designation now
     protected $hidden = ['type'];
 
     protected $casts = [
-        'service_id'         => 'integer',
-        'config'             => 'array',
-        'queued'             => 'boolean',
-        'storage_service_id' => 'integer',
+        'service_id'             => 'integer',
+        'config'                 => 'array',
+        'queued'                 => 'boolean',
+        'storage_service_id'     => 'integer',
+        'implements_access_list' => 'boolean'
     ];
 
     /**
@@ -88,8 +90,6 @@ protected static function prepareConfigSchemaField(array &$schema)
                 break;
             case 'queued':
                 $schema['label'] = 'Queue For Later Execution';
-                $schema['type'] = 'boolean';
-                $schema['default'] = false;
                 $schema['description'] =
                     'Select to queue the script for later execution ' .
                     '(queuing success or failure returned to client immediately), ' .
@@ -113,6 +113,12 @@ protected static function prepareConfigSchemaField(array &$schema)
             case 'storage_service_id':
                 $schema['type'] = 'integer';
                 break;
+            case 'implements_access_list':
+                $schema['label'] = 'Script Implements Access List';
+                $schema['description'] =
+                    'By default, the access list is generated by the OpenAPI specification provided. ' .
+                    'To override, check this and implement the access list in the script.';
+                break;
         }
     }
 }