Merge branch 'master' into feature/sandbox-auto-scheduled

Author: tobiaslohr

bin/test-cli.sh

@@ -394,6 +394,24 @@ else
 	exit 1
 fi
 
+echo "Testing command ´sfcc-ci sandbox:create --realm <realm> --profile <INVALID_PROFILE>´ (expected to fail):"
+node ./cli.js sandbox:create --realm $ARG_SANDBOX_REALM --profile INVALID_PROFILE
+if [ $? -eq 1 ]; then
+    echo -e "\t> OK"
+else
+	echo -e "\t> FAILED"
+	exit 1
+fi
+
+echo "Testing command ´sfcc-ci sandbox:create --realm <realm> --profile large´ --ttl 3:"
+node ./cli.js sandbox:create --realm $ARG_SANDBOX_REALM --profile large --ttl 3
+if [ $? -eq 0 ]; then
+    echo -e "\t> OK"
+else
+	echo -e "\t> FAILED"
+	exit 1
+fi
+
 echo "Testing command ´sfcc-ci sandbox:create --realm <realm> --ttl 1 --sync´:"
 node ./cli.js sandbox:create --realm $ARG_SANDBOX_REALM --ttl 1 --sync
 if [ $? -eq 0 ]; then

cli.js

@@ -286,6 +286,7 @@ program
     .option('-r, --realm <realm>','Realm to create the sandbox for')
     .option('-t, --ttl <hours>','Number of hours the sandbox will live')
     .option('--auto-scheduled', 'Sets the sandbox as being auto scheduled')
+    .option('-p, --profile <profile>','Resource profile used for the sandbox, "medium" is the default')
     .option('--ocapi-settings <json>','Additional OCAPI settings applied to the sandbox')
     .option('--webdav-settings <json>','Additional WebDAV permissions applied to the sandbox')
     .option('-j, --json','Formats the output in json')
@@ -297,14 +298,15 @@ program
         var realm = ( options.realm ? options.realm : null );
         var ttl = ( options.ttl ? parseInt(options.ttl) : null );
         var autoScheduled = ( options.autoScheduled ? options.autoScheduled : false );
+        var profile = ( options.profile ? options.profile : null );
         var asJson = ( options.json ? options.json : false );
         var sync = ( options.sync ? options.sync : false );
         var setAsDefault = ( options.default ? options.default : false );
         var alias = ( options.setAlias ? options.setAlias : null );
         var ocapiSettings = ( options.ocapiSettings ? options.ocapiSettings : null );
         var webdavSettings = ( options.webdavSettings ? options.webdavSettings : null );
-        require('./lib/sandbox').cli.create(realm, alias, ttl, autoScheduled, ocapiSettings, webdavSettings, asJson,
-            sync, setAsDefault);
+        require('./lib/sandbox').cli.create(realm, alias, ttl, profile, autoScheduled, ocapiSettings, webdavSettings,
+            asJson, sync, setAsDefault);
     }).on('--help', function() {
         console.log('');
         console.log('  Details:');
@@ -319,6 +321,10 @@ program
         console.log('  schedule configured at sandbox realm level. By default or if omitted the sandbox is not auto');
         console.log('  scheduled.');
         console.log();
+        console.log('  Use the optional --profile <profile> to set the resource allocation for the sandbox, "medium"');
+        console.log('  is the default. Be careful, more powerful profiles consume more credits. Supported values');
+        console.log('  are: medium, large, xlarge.');
+        console.log();
         console.log('  You can force the command to wait until the creation of the sandbox has been finished and the');
         console.log('  sandbox is available to use (in "started" status) by using the --sync flag. By default the');
         console.log('  command will poll the status for 10 minutes. You can overwrite this by using the environment');
@@ -350,6 +356,7 @@ program
         console.log('    $ sfcc-ci sandbox:create -r my-realm -s -j');
         console.log('    $ sfcc-ci sandbox:create -r my-realm --ttl 6');
         console.log('    $ sfcc-ci sandbox:create -r my-realm --auto-scheduled');
+        console.log('    $ sfcc-ci sandbox:create -r my-realm -p large');
         console.log();
     });
 

lib/job.js

@@ -33,7 +33,7 @@ function runJob(instance, job_id, request_doc, token, callback) {
     var options = ocapi.getOptions(instance, endpoint, token);
 
     // the post body
-    options['body'] = (request_doc ? request_doc : {});
+    options['body'] = (request_doc ? request_doc : null);
 
     // just do the request and pass the callback
     request.post(options, callback);
@@ -243,14 +243,12 @@ function status(instance, job_id, job_execution_id, verbose, streamLog, openLogF
 }
 
 function buildParameters(job_params) {
-    var params = {
-        parameters: []
-    };
+    var params = [];
 
     if (job_params) {
         job_params.forEach(function (param) {
             var split = param.split('=');
-            params.parameters.push({
+            params.push({
                 name: split[0],
                 value: (split.length > 1 ? split[1] : null)
             });
@@ -293,8 +291,8 @@ module.exports.api = {
         if (typeof(job_id) !== 'string') {
             throw new TypeError('Parameter job_id missing or not of type String');
         }
-        if (!(typeof(job_params) === 'object' && Array.isArray(job_params))) {
-            throw new TypeError('Parameter job_params must either be an array');
+        if (typeof(job_params) !== 'object') {
+            throw new TypeError('Parameter job_params must either be null or not of type Object');
         }
         if (typeof(token) !== 'string') {
             throw new TypeError('Parameter token missing or not of type String');

lib/sandbox.js

@@ -49,6 +49,7 @@ const SANDBOX_STATUS_POLL_ERROR_THRESHOLD = 3;
 const SANDBOX_STATUS_UP_AND_RUNNING = 'started';
 const SANDBOX_STATUS_FAILED = 'failed';
 const BM_PATH = '/on/demandware.store/Sites-Site';
+const SANDBOX_RESOURCE_PROFILES = [ 'medium', 'large', 'xlarge' ];
 
 // enable request debugging
 if ( process.env.DEBUG ) {
@@ -422,12 +423,13 @@ function getSandboxHost(sandbox) {
  *
  * @param {String} realm the realm to create the sandbox for
  * @param {String} ttl the ttl of the sandbox in hours
+ * @param {String} profile the resource profile of the sandbox
  * @param {Boolean} autoScheduled sets the sandbox as auto scheduled
  * @param {String} additionalOcapiSettings JSON string holding additonal OCAPI settings to pass
  * @param {String} additionalWebdavSettings JSON string holding additonal WebDAV permissions to pass
  * @param {Function} callback the callback to execute, the error and the created sandbox are available as arguments to the callback function
  */
-function createSandbox(realm, ttl, autoScheduled, additionalOcapiSettings, additionalWebdavSettings, callback) {
+function createSandbox(realm, ttl, profile, autoScheduled, additionalOcapiSettings, additionalWebdavSettings, callback) {
     if (!realm && dwjson['realm']) {
         realm = dwjson['realm'];
         console.debug('Using realm id %s from dw.json at %s', dwjson['realm'], process.cwd());
@@ -483,6 +485,16 @@ function createSandbox(realm, ttl, autoScheduled, additionalOcapiSettings, addit
         options['body']['autoScheduled'] = true;
     }
 
+    // the profile, if passed
+    if (profile !== null) {
+        if (SANDBOX_RESOURCE_PROFILES.indexOf(profile) === -1) {
+            callback(new Error(`Invalid resource profile '${profile}', use one of:
+                ${SANDBOX_RESOURCE_PROFILES.join(', ')}`));
+            return;
+        }
+        options['body']['resourceProfile'] = profile;
+    }
+
     ocapi.retryableCall('POST', options, function(err, res) {
         var errback = captureCommonErrors(err, res);
         if ( !errback ) {
@@ -937,19 +949,21 @@ module.exports.cli = {
      * @param {String} realm the realm to create the sandbox in
      * @param {String} alias the alias to use for the created sandbox
      * @param {Number} ttl number of hours, the sandbox will live (if absent the realm default ttl is used)
+     * @param {String} profile resource profile used (if absent "medium" is used)
      * @param {Boolean} autoScheduled sets the sandbox as auto scheduled (false by default)
      * @param {String} ocapiSettings additional ocapi settings
      * @param {String} webdavPermissions additional webdav permissions
      * @param {Boolean} asJson optional flag to force output in json, false by default
      * @param {Boolean} sync whether to operate in synchronous mode, false by default
      * * @param {Boolean} setAsDefault optional flag to set as new default instance, false by default
      */
-    create : function(realm, alias, ttl, autoScheduled, ocapiSettings, webdavPermissions, asJson, sync, setAsDefault) {
+    create : function(realm, alias, ttl, profile, autoScheduled, ocapiSettings, webdavPermissions, asJson, sync,
+        setAsDefault) {
         // memorize the start time and duration
         var startTime = Date.now();
         var duration = 0;
 
-        createSandbox(realm, ttl, autoScheduled, ocapiSettings, webdavPermissions, function(err, newSandbox) {
+        createSandbox(realm, ttl, profile, autoScheduled, ocapiSettings, webdavPermissions, function(err, newSandbox) {
             if (err) {
                 if (asJson) {
                     console.json({error: err.message});

package-lock.json

@@ -29,7 +29,7 @@
     "commander": "^2.18.0",
     "conf": "^4.0.2",
     "del": "^5.1.0",
-    "dotenv": "^8.2.0",
+    "dotenv": "^8.6.0",
     "globby": "^11.0.1",
     "inquirer": "^6.2.0",
     "jsondiffpatch": "^0.4.1",

package.json

@@ -16,17 +16,14 @@ describe('Tests for lib/job.js', function() {
 
         it('should return empty array, if no argument passed', function() {
             var result = require('../../lib/job').buildParameters([]);
-            expect(result).to.be.an('object');
-            expect(result.parameters).to.be.an('array').that.is.empty;
+            expect(result).to.be.an('array').that.is.empty;
         });
 
         it('should properly split cli args', function() {
             var result = require('../../lib/job').buildParameters(['param1=value1','param2=value2']);
             var expected = [{name: 'param1', value: 'value1'},{name: 'param2', value: 'value2'}];
 
-            expect(result).to.be.an('object');
-            expect(result.parameters).to.be.an('array').that.is.not.empty;
-            expect(result.parameters).to.have.deep.members(expected);
+            expect(result).to.have.deep.members(expected);
         });
     });
 });