nistonomicon/util/controlTestRunner.js

NIST 800-53 Security Control Assessment Test Suite

var Mocha = require('mocha')
var control_list = require('./controlListParser.js').parsedControls
var reportBuilder = require('./reportBuilder.js')

//this function takes the overlay, inherited tests and implemented tests and builds a dictionary 
var appendTest = function(provider, control_name, f, test_dict) {
    if(test_dict.hasOwnProperty(control_name)) { //if it already has a test entry for this control test
        //console.log(test_dict)
        test_dict[control_name].push({
            f: f,
            provider: provider
        })
    } else {
        test_dict[control_name] = [{
            f: f,
            provider: provider
        }]
    }
    return test_dict
}
var inheritanceBuilder = function(inheritedTests) {
    test_dict = {}
    if(inheritedTests === {} || inheritedTests === [] || inheritedTests === null) {
        return test_dict
    } else {
        for(item in inheritedTests) {
            //no specified provider
            if(inheritedTests[item].constructor == Function) { //single inherited function
                //console.log('function');
                test_dict = appendTest('inheritance provider uknown', item, inheritedTests[item], test_dict)
                //specificed provider
            } else if(inheritedTests[item].constructor == Object) { //checks to see if this is a list of providers
                controlProvider = inheritedTests[item]
                controlProviderName = item
                for(control in controlProvider) {
                    test_dict = appendTest('inherited from ' + controlProviderName, control, controlProvider[control], test_dict)
                }
            }
        }
    }
    return test_dict
}
var assembleTestDict = function(overlay, inheritedTests, implementedTests) {
    var test_dict = {}
    inheritedTests = inheritanceBuilder(inheritedTests)
    //         if(implementedTests.hasOwnProperty(control_name)) { //checks for implemented tests 
    //             console.log(test_dict)
    //             if(test_dict.hasOwnProperty(control_name)) { //if there are inherited tests and implemented tests
    //                 test_dict = appendTest('implemented by project', control_name, implementedTests[control_name], test_dict)
    //             }
    for(control in overlay) {
        control_name = overlay[control]
        if(inheritedTests.hasOwnProperty(control_name) && implementedTests.hasOwnProperty(control_name)) {
            test_dict[control_name] = inheritedTests[control_name];
            test_dict = appendTest('supplied test', control_name, implementedTests[control_name], test_dict)
        } else if(inheritedTests.hasOwnProperty(control_name)) { //checks first for inherited tests
            test_dict[control_name] = inheritedTests[control_name];
        } else if(implementedTests.hasOwnProperty(control_name)) {
            test_dict[control_name] = implementedTests[control_name];
        } else {
            test_dict[control_name] = test_pending //adds in pending for potential new tests
        }
    }
    //console.log(test_dict)
    return test_dict
}
var executeTest = function(test_name, test) {
    if(undefined !== test) {
        if(test.constructor == Array) { //inheritance parsing
            for(itest in test) {
                var test_full_name = test_name + ' (' + test[itest].provider + ')'
                if(test[itest].f.hasOwnProperty('metadata')) { //this checks to see if the test has attached metadata
                    it(test_full_name, test[itest].f.f)
                    reportBuilder.addMetadata(test_full_name, test[itest].f.metadata)
                } else {
                    it(test_name + ' (' + test[itest].provider + ')', test[itest].f)
                }
            }
        } else { // an implemented test
            if(test.hasOwnProperty('metadata')) { //this checks to see if the test has attached metadata
                it (test_name,test.f)
                reportBuilder.addMetadata(test_name,test.metadata)
            } else {
                it(test_name, test)
            }
        }
    }
}
var executeEnhancements = function(enhancements, test_dict) {
    for(enhancement in enhancements) {
        enhancement_title = enhancements[enhancement]
        executeTest(enhancement + " " + enhancement_title, test_dict[enhancement])
    }
}
var executeControl = function(control, control_number, test_dict) {
    if(control.hasOwnProperty('enhancements')) { //checking to see if there are any enhancements
        executeTest(control_number + " " + control.title, test_dict[control_number]) //this is the base control
        executeEnhancements(control['enhancements'], test_dict)
    } else {
        executeTest(control_number + " " + control.title, test_dict[control_number]) //this is the base control
    }
}
var executeFamily = function(family, test_dict) {
    for(control in family) { //for all of the controls in each family
        control_title = family[control].title
        describe(control_title, function() {
            executeControl(family[control], control, test_dict)
        });
    }
}
var startTests = function(control_list, test_dict) {
    for(family in control_list) { //for each of the 18 families in the controls 
        describe(family, function() {
            executeFamily(control_list[family], test_dict)
        })
    }
};
var test_pending = function(done) {
    this.skip('works', function() {
        // nothing yet
    });
}
var overlay = require('../index.js').overlay
var inherited_dict = require('../index.js').inherited_dict
var implemented_dict = require('../index.js').implemented_dict
var test_dict = assembleTestDict(overlay, inherited_dict, implemented_dict);
startTests(control_list, test_dict);