azure-scripty

Azure automation made easy

npm install azure-scripty
23 downloads in the last month

azure-scripty

Azure automation made easy.

Build Status

azure-scripty is a little helper library that makes it really easy to create node automation scripts using the azure-cli.

Features

  • Invoke one or more CLI commands easily from within your code.
  • Supports all CLI commands, if you know the CLI you know scripty!
  • Returns JSON objects from each cmd. Useful for complex scripting scenarios.
  • Cross platform, works on Windows, Mac and Linux.

Getting started

Install it

npm install azure-scripty

To use scripty, call the invoke method passing in one or more commands. Commands are the arguments that you would normally pass when calling azure-cli from the shell.

Single command style

You can pass a single command to scripty along with a callback.

var scripty = require('azure-scripty');
scripty.invoke('site list', function(err, results) {
  console.log("my sites\n" + results);
});
`

Increasing the output buffer size

By default scripty uses the standard default buffer size of 204800 bytes. This may be insufficent for some scenarios like listing out hundreds of blobs resulting an error indicating the buffer size is too small. For these cases you can increase the buffer size using by setting maxBuffer.

var scripty = require('azure-scripty');
scripty.maxBuffer = 999999999;

Single command object style

You can also pass a command object where properties map to different parameters. This is useful for programattic scenarios where a function returns an object that you just pass in.

  • The 'Command' property holds the command name.
  • 'Positional' is an array of values that will be added positionally at the beginning.
  • The rest of the properties are optional and will be appended with --[Property Name] and the value i.e. --Foo Bar.
  • For quoted values, use a double quotes within the single quotes i.e. {'name':'"foo bar"'}.
  • For parameters which are flags i.e. --git, the value can be null, '' or 'true'.

For example passing the command below

var scripty = require('azure-scripty');
cmd = {
  command: 'mobile create',
  positional: ['mymobileservice', 'sqladmin', 'myP@ssw0rd!'],
  sqlServer: 'VMF1ASD',
  sqlDb: 'mydb'
};
scripty.invoke(cmd, function() {})

will end up with the following resulting command.

mobile create mymobileserver sqladmin myP@ssw0rd! --sqlServer VMF1ASD --sqlDb myDB

Multi-command style

You can pass a collection of cmds to be called in sequence. Below for example I am create a site and then configuring it.

var scripty = require('azure-scripty');
scripty.invoke(['site create mysite --git', 'site config add foo=bar', 'site show mysite'], function(err, results){
  console.log(results[2]) //shows the site details
});
`

The results parameter in the callback will contain an array of all returned objects

Multi command object style

Similar to the single command, you can also pass multiple command objects. See the example below.

var scripty = require('azure-scripty');
cmds = [
  {
    command: 'mobile create',
    positional: ['mymobileservice', 'sqladmin', 'myP@ssw0rd!'],
    sqlServer: 'VMF1ASD',
    sqlDb: 'mydb'
  },
  {
    command: 'site create',
    positional: ['site1'],
    location: '"West US"',
    subscription: 'foobar'
    git:true
  }
]

scripty.invoke(cmds, function() {});

When this runs, the following commands will be created.

mobile create mymobileserver sqladmin myP@ssw0rd! --sqlServer VMF1ASD --sqlDb myDB
site create site1 --location "West US" --subscription foobar --git

Multi-command with step callbacks

An alternative style that is supported is to pass a collection of cmd objects with callbacks. This is useful for performing actions after a step like logging. You can do much more in the callback which will be covered in the section on piping under the topic "Custom logic, filters, and transformations"

var scripty = require('azure-scripty');
var steps={
  sites:function(callback,result) {
    //contains just sites
    console.log("sites\n" + result;
    callback(undefined, result);
  },
  vms:function(callback,result) {
    //contains just vms
    console.log("vms\n" + result;
    callback(undefined, result);
  }
  complete:function(err, results) {
    //contains both
    console.log("results\n" + results;
    callback(undefined, result);
  }
};
var cmds=[
  {cmd:'site list', callback:steps.sites},
  {cmd:'vm list', callback:steps.vms}
];
scripty.invoke(cmds, steps.complete);

This also works with command object style, so you can pass in a full command with a callback.

Piping

Scripty supports the ability to pipe results between commands. To pipe, the command having results piped in should contain substituion placeholders in the parameters. A placeholder is in the form of ':' + property name ex. ':Name'

Piping multiple results.

If a command to be piped into is immediately after a command returning a collection then the command will be called for each item in the collection.

For example in the example below the :Name property is specified for 'site stop'. Assuming 'site list' returns 2 sites 'foo' and 'bar' then 'site stop foo' and 'site stop bar' will be called.

var scripty = require('azure-scripty');
scripty.invoke(['site list', 'site stop :name'], function(){});

Piping single results

You can also pipe a result which is not a collection to the next call.

Below the first call retrieves the Service Bus namespace myns and then pipes the connection string to a config setting.

var scripty = require('azure-scripty')
scripty.invoke(['sb namespace show myns', "site config add \"conn=':ConnectionString'\" mysite"], 
  function(){});

Custom logic, filters, and transformations

scripty supports the ability to apply custom filtering logic with piping. We can modify the earlier site example to only stop web sites in "West US". To do this you simply filter the list of websites with custom logic in the callback for the step where the sites are returned. You can see this below.

var scripty =  require('azure-scripty');
var steps={
  sites:function(callback,result) {
    //apply a filter
    var filtered = result.filter(function(item) {
      return (item.webSpace === 'westuswebspace'); 
    });
    //return the filtered result
    callback(undefined, filtered);
  },
  complete:function(err, result) {
    console.log(result);
  }
};
var cmds=[
  {cmd:'site list', callback:steps.sites}
  {cmd: 'site stop :name'}
];
scripty.invoke(cmds, steps.complete);

Accessing the next command / modifying it dynamically

Additionally you can grab the next command in the chain and modify it dynamically. To do this add a callback for the command that has a 3rd parameter for the next command. When scripty executes it will pass in the next command which can be inspected or modified. For example below the the sql server created with the first command will then be set as a positional argument for the next command.

var cmds=[
  {cmd:'mobile show clidemo', callback:onShow},
  {cmd:'mobile create clidemo2'}
];

function onShow(callback, result, nextCommand) {
  // do stuff with result
 nextCommand.positional = [result.sqlServer]
 callback(undefined, result);
}

scripty.invoke(cmds, function() { console.log('done'); } );

Known issues

  • When using piping, parameters currently match case sensitively. Please make sure the names match exactly.

License

Apache 2: http://www.apache.org/licenses/LICENSE-2.0.html

npm loves you