feature/136: Added Azure VM Automatic OS Upgrades Enabled plugin, test cases

exports.js

@@ -383,6 +383,7 @@ module.exports = {
         'scaleSetMultiAz'               : require(__dirname + '/plugins/azure/virtualmachines/scaleSetMultiAz.js'),
         'scaleSetAutoscaleEnabled'      : require(__dirname + '/plugins/azure/virtualmachines/scaleSetAutoscaleEnabled.js'),
         'vmAvailabilitySetLimit'        : require(__dirname + '/plugins/azure/virtualmachines/vmAvailabilitySetLimit.js'),
+        'autoOsUpgradesEnabled'         : require(__dirname + '/plugins/azure/virtualmachines/autoOsUpgradesEnabled.js'),
         'noUnattachedDisks'             : require(__dirname + '/plugins/azure/virtualmachines/noUnattachedDisks.js'),
 
         'lbLogAnalyticsEnabled'         : require(__dirname + '/plugins/azure/monitor/lbLogAnalyticsEnabled.js'),

plugins/azure/virtualmachines/autoOsUpgradesEnabled.js

@@ -0,0 +1,55 @@
+const async = require('async');
+const helpers = require('../../../helpers/azure');
+
+module.exports = {
+    title: 'Automatic OS Upgrades Enabled',
+    category: 'Virtual Machines',
+    description: 'Ensure that automatic operating system (OS) upgrades are enabled for Microsoft Azure virtual machine scale sets.',
+    more_info: 'Enabling automatic OS image upgrades on your scale set helps ease update management by safely and automatically upgrading the OS disk for all instances in the scale set.',
+    recommended_action: 'Enable automatic OS upgrades under operating system settings',
+    link: 'https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-automatic-upgrade',
+    apis: ['virtualMachineScaleSets:listAll'],
+
+    run: function(cache, settings, callback) {
+        const results = [];
+        const source = {};
+        const locations = helpers.locations(settings.govcloud);
+
+        async.each(locations.virtualMachineScaleSets, (location, rcb) => {
+
+            const virtualMachineScaleSets = helpers.addSource(cache, source,
+                ['virtualMachineScaleSets', 'listAll', location]);
+
+            if (!virtualMachineScaleSets) return rcb();
+
+            if (virtualMachineScaleSets.err || !virtualMachineScaleSets.data) {
+                helpers.addResult(results, 3,
+                    'Unable to query for Virtual Machine Scale Sets: ' + helpers.addError(virtualMachineScaleSets), location);
+                return rcb();
+            }
+
+            if (!virtualMachineScaleSets.data.length) {
+                helpers.addResult(results, 0, 'No existing Virtual Machine Scale Sets found', location);
+                return rcb();
+            }
+
+            virtualMachineScaleSets.data.forEach(virtualMachineScaleSet => {
+                if (virtualMachineScaleSet.upgradePolicy &&
+                    virtualMachineScaleSet.upgradePolicy.automaticOSUpgradePolicy &&
+                    virtualMachineScaleSet.upgradePolicy.automaticOSUpgradePolicy.enableAutomaticOSUpgrade) {
+                    helpers.addResult(results, 0,
+                        'Automatic OS upgrades feature is enabled for virtual machine scale set',
+                        location, virtualMachineScaleSet.id);
+                } else {
+                    helpers.addResult(results, 2,
+                        'Automatic OS upgrades feature is not enabled for virtual machine scale set',
+                        location, virtualMachineScaleSet.id);
+                }
+            });
+
+            rcb();
+        }, function() {
+            callback(null, results, source);
+        });
+    }
+};

plugins/azure/virtualmachines/autoOsUpgradesEnabled.spec.js

@@ -0,0 +1,105 @@
+var expect = require('chai').expect;
+var plugin = require('./autoOsUpgradesEnabled');
+
+const createCache = (err, list) => {
+    return {
+        virtualMachineScaleSets: {
+            listAll: {
+                'eastus': {
+                    err: err,
+                    data: list
+                }
+            }
+        }
+    }
+};
+
+describe('autoOsUpgradesEnabled', function() {
+    describe('run', function() {
+        it('should give unknown result if unable to query for Virtual Machine Scale Sets', function(done) {
+            const callback = (err, results) => {
+                expect(results.length).to.be.above(0)
+                expect(results[0].status).to.equal(3)
+                expect(results[0].message).to.include('Unable to query for Virtual Machine Scale Sets')
+                expect(results[0].region).to.equal('eastus')
+                done()
+            };
+
+            const cache = createCache(
+                ['error'],
+                null
+            );
+
+            plugin.run(cache, {}, callback);
+        });
+        it('should give passing result if no existing Virtual Machine Scale Sets found', function(done) {
+            const callback = (err, results) => {
+                expect(results.length).to.be.above(0)
+                expect(results[0].status).to.equal(0)
+                expect(results[0].message).to.include('No existing Virtual Machine Scale Sets found')
+                expect(results[0].region).to.equal('eastus')
+                done()
+            };
+
+            const cache = createCache(
+                null,
+                []
+            );
+
+            plugin.run(cache, {}, callback);
+        });
+        it('should give passing result if automatic OS upgrades feature is enabled for virtual machine scale set', function(done) {
+            const callback = (err, results) => {
+                expect(results.length).to.be.above(0)
+                expect(results[0].status).to.equal(0)
+                expect(results[0].message).to.include('Automatic OS upgrades feature is enabled for virtual machine scale set')
+                expect(results[0].region).to.equal('eastus')
+                done()
+            };
+
+            const cache = createCache(
+                null,
+                [
+                    {
+                        "id": "/subscriptions/123/AQUA-RG/providers/Microsoft.Compute/virtualMachineScaleSets/vmss-1",
+                        "type": "Microsoft.Compute/virtualMachineScaleSets",
+                        "location": "West US",
+                        "upgradePolicy": {
+                            "mode": "Automatic",
+                            "automaticOSUpgradePolicy": {
+                                "enableAutomaticOSUpgrade": true
+                            }
+                        }
+                    },
+                ]
+            );
+
+            plugin.run(cache, {}, callback);
+        });
+        it('should give failing result if automatic OS upgrades feature is not enabled for virtual machine scale set', function(done) {
+            const callback = (err, results) => {
+                expect(results.length).to.be.above(0)
+                expect(results[0].status).to.equal(2)
+                expect(results[0].message).to.include('Automatic OS upgrades feature is not enabled for virtual machine scale set')
+                expect(results[0].region).to.equal('eastus')
+                done()
+            };
+
+            const cache = createCache(
+                null,
+                [
+                    {
+                        "id": "/subscriptions/123/AQUA-RG/providers/Microsoft.Compute/virtualMachineScaleSets/vmss-1",
+                        "type": "Microsoft.Compute/virtualMachineScaleSets",
+                        "location": "West US",
+                        "upgradePolicy": {
+                            "mode": "Manual",
+                        }
+                    },
+                ]
+            );
+
+            plugin.run(cache, {}, callback);
+        })
+    })
+})