How to use preflightChecks method in Appium

1'use strict';2// Internal dependencies3const render = require('../helpers/render');4const forms = require('../helpers/forms');5const router = require('express').Router();6const getResourceErrorHandler = require('./resource-error-handler');7/**8 * This is a generic class to provide middleware for Browse/Read/Edit/Add/Delete9 * operations and forms. It comes with some baked-in pre-flight checks but needs10 * to be extended to do useful work. All default actions except reads require11 * being logged in.12 *13 * Use the bakery method to create standard BREAD routes. :)14 */15class AbstractBREADProvider {16  /**17   * @param {IncomingMessage} req18   *  Express request19   * @param {ServerResponse} res20   *  Express response21   * @param {Function} next22   *  Express callback to move on to next middleware23   * @param {Object} [options]24   *  What kind of route to create25   * @param {String} options.action='add'26   *  one of 'browse', 'read' (view), 'add' (create), 'edit', 'delete'27   * @param {String} options.method='GET'28   *  what HTTP method this route responds to29   * @param {String} options.id30   *  if required, what object ID to look up31   * @param {String} options.someOtherID32   *  will also be assigned to `this`33   */34  constructor(req, res, next, options) {35    if (new.target === AbstractBREADProvider)36      throw new TypeError('AbstractBREADProvider is an abstract class, please instantiate a derived class.');37    if (!req || !res || !next)38      throw new Error('Form needs at least req, res, and next functions from middleware.');39    this.actions = {40      browse: {41        // Function to call for GET requests42        GET: this.browse_GET,43        // Checks to perform before either of above functions are called.44        // If checks fail, they are not called (checks have to handle45        // the request).46        preFlightChecks: [],47        // Title for all "browse" actions48        titleKey: undefined49      },50      read: {51        GET: this.read_GET,52        preFlightChecks: [],53        // Function to call to load data and pass it to GET/POST function.54        // This must perform exclusion of deleted or stale revisions.55        loadData: this.loadData,56        titleKey: undefined57      },58      add: {59        GET: this.add_GET,60        // Function to call for POST requests61        POST: this.add_POST,62        preFlightChecks: [this.userIsSignedIn],63        titleKey: undefined64      },65      edit: {66        GET: this.edit_GET,67        POST: this.edit_POST,68        preFlightChecks: [this.userIsSignedIn],69        // Function to call to load data and pass it to GET/POST function70        loadData: this.loadData,71        // Function to call to validate that user can perform this action,72        // once we have a resource to check against.73        resourcePermissionCheck: this.userCanEdit,74        titleKey: undefined75      },76      delete: {77        GET: this.delete_GET,78        POST: this.delete_POST,79        preFlightChecks: [this.userIsSignedIn],80        loadData: this.loadData,81        resourcePermissionCheck: this.userCanDelete,82        titleKey: undefined83      }84    };85    // Middleware functions86    this.req = req;87    this.res = res;88    this.next = next;89    // This is used for "not found" messages that must be in the format90    // "x not found" (for the body) and "x not found title" (for the title)91    this.messageKeyPrefix = '';92    // Defaults93    options = Object.assign({94      action: 'add',95      method: 'GET',96      id: undefined // only for edit/delete operations97    }, options);98    Object.assign(this, options);99    // Shortcuts to common helpers, which also lets us override these with100    // custom methods if appropriate101    this.renderTemplate = render.template.bind(render, this.req, this.res);102    this.renderResourceError = render.resourceError.bind(render, this.req, this.res);103    this.renderPermissionError = render.permissionError.bind(render, this.req, this.res);104    this.renderSigninRequired = render.signinRequired.bind(render, this.req, this.res);105    this.getResourceErrorHandler = getResourceErrorHandler.bind(getResourceErrorHandler, this.req, this.res, this.next);106    this.parseForm = forms.parseSubmission.bind(forms, this.req);107  }108  execute() {109    let actions = Object.keys(this.actions);110    if (actions.indexOf(this.action) == -1)111      throw new Error('Did not recognize form action: ' + this.type);112    if (typeof this.actions[this.action][this.method] != 'function')113      throw new Error('No defined handler for this method.');114    // Perform pre-flight checks (e.g., permission checks). Pre-flight checks115    // are responsible for rendering failure/result messages, so no116    // additional rendering will take place if any checks fail.117    let mayProceed = true;118    for (let check of this.actions[this.action].preFlightChecks) {119      let result = Reflect.apply(check, this, []);120      if (!result) {121        mayProceed = false;122        break; // First check to fail will be responsible for rendering error123      }124    }125    if (!mayProceed)126      return;127    if (!this.actions[this.action].loadData)128      Reflect.apply(this.actions[this.action][this.method], this, []); // Call appropriate handler129    else {130      // Asynchronously load data and show 404 if not found131      Reflect.apply(this.actions[this.action].loadData, this, [])132        .then(data => {133          // If we have a permission check, only proceeds if it succeeds.134          // If we don't have a permission check, proceed.135          if (!this.actions[this.action].resourcePermissionCheck ||136            Reflect.apply(this.actions[this.action].resourcePermissionCheck, this, [data]))137            Reflect.apply(this.actions[this.action][this.method], this, [data]);138        })139        .catch(this.getResourceErrorHandler(this.messageKeyPrefix, this.id));140    }141  }142  userIsSignedIn() {143    if (!this.req.user) {144      this.renderSigninRequired({145        titleKey: this.actions[this.action].titleKey146      });147      return false;148    } else149      return true;150  }151  userIsTrusted() {152    if (!this.req.user || !this.req.user.isTrusted) {153      this.renderPermissionError({154        titleKey: this.actions[this.action].titleKey,155        detailsKey: "must be trusted",156      });157      return false;158    } else159      return true;160  }161  userCan(action, data) {162    data.populateUserInfo(this.req.user);163    if (action == 'edit' && data.userCanEdit)164      return true;165    else if (action == 'delete' && data.userCanDelete)166      return true;167    else {168      this.renderPermissionError({169        titleKey: this.actions[this.action].titleKey170      });171      return false;172    }173  }174  userCanEdit(data) {175    return this.userCan('edit', data);176  }177  userCanDelete(data) {178    return this.userCan('delete', data);179  }180  // Adds a pre-flight check to all actions in provided array.181  // If not defined, adds to all actions182  addPreFlightCheck(actions, check) {183    if (!actions)184      actions = Object.keys(this.actions);185    for (let action of actions)186      this.actions[action].preFlightChecks.push(check);187  }188}189AbstractBREADProvider.getDefaultRoutes = function(resource) {190  // The default does not (yet) include a browse route.191  // The code below parses the IDs in the route, so be careful adding192  // non-standard patterns.193  return {194    add: {195      path: `/new/${resource}`,196      methods: ['GET', 'POST']197    },198    read: {199      path: `/${resource}/:id`,200      methods: ['GET']201    },202    edit: {203      path: `/${resource}/:id/edit`,204      methods: ['GET', 'POST']205    },206    delete: {207      path: `/${resource}/:id/delete`,208      methods: ['GET', 'POST']209    }210  };211};212// This registers default routes that are common for editable resources,213// following a standard pattern.214//215// resource -- the identifier used in URLs for the resource216//  that is being configured.217//218// routes (optional) -- actions and associated Express routes that we want to219//   set up. POST routes will only be created for add/edit/delete actions.220AbstractBREADProvider.bakeRoutes = function(resource, routes) {221  let Provider = this;222  if (!routes)223    routes = this.getDefaultRoutes(resource);224  function _bakeRoute(action, method, idArray) {225    return function(req, res, next) {226      let options = {227        action,228        method229      };230      // We always initialize each provider with the provided IDs,231      // ready for use as object properties.232      idArray.forEach(id => (options[id] = req.params[id]));233      let provider = new Provider(req, res, next, options);234      provider.execute();235    };236  }237  for (let action in routes) {238    // Extract variable placeholders239    let idMatches = routes[action].path.match(/\/:(.*?)(\/|$)/g);240    // Extract variable names241    let idArray = idMatches ? idMatches.map(id => id.match(/\w+/)[0]) : [];242    // Register router function for each specified method (GET, POST, etc.).243    // The router methods like router.get() are lower case.244    for (let method of routes[action].methods)245      router[method.toLowerCase()](routes[action].path,246        _bakeRoute(action, method, idArray));247  }248  return router;249};...

1var devopsmodeller = require('./modeller.js')2var ent = require('@bluefin605/entmodeller')3var enumBuilder = require('@bluefin605/entmodeller-devops-enumerator')4const DevOpsModeller = (function () {5    const _private = new WeakMap()6    const internal = (key) => {7        // Initialize if not created8        if (!_private.has(key)) {9            _private.set(key, {})10        }11        // Return private properties object12        return _private.get(key)13    }14    class DevOpsModeller {15        constructor(devOpsEnumBuilder, entModellerBuilder, attachmentMappers, releaseMappers, environmentMappers, transformers, preflightChecks) {16            internal(this).devOpsEnumBuilder = devOpsEnumBuilder;17            internal(this).entModellerBuilder = entModellerBuilder;18            internal(this).attachmentMappers = attachmentMappers;19            internal(this).releaseMappers = releaseMappers;20            internal(this).environmentMappers = environmentMappers;21            internal(this).transformers = transformers;22            internal(this).preflightChecks = preflightChecks;23        }24        static get Builder() {25            class Builder {26                constructor() {27                    internal(this).attachmentMappers = [];28                    internal(this).environmentMappers = [];29                    internal(this).releaseMappers = [];30                    internal(this).transformers = [];31                    internal(this).entModellerBuilder = new ent.EntModeller.Builder();32                    internal(this).devOpsEnumBuilder = new enumBuilder.Builder();33                    internal(this).PreflightBuilder = new PreflightBuilder();34                }35                addNameTransformation(transform) {36                    internal(this).transformers.push(transform);37                    return this;38                }39                addAttachmentMapping(id, mapper) {40                    internal(this).attachmentMappers.push({id: id, mapper: mapper});41                    return this;42                }43                addReleaseMapping(mapper) {44                    internal(this).releaseMappers.push({mapper: mapper});45                    return this;46                }47                addEnvironmentMapping(mapper) {48                    internal(this).environmentMappers.push({mapper: mapper});49                    return this;50                }51                addPreflightChecks(initial, checks) {52                    internal(this).PreflightBuilder.setInitialPayload(initial);53                    checks(internal(this).PreflightBuilder);54                    return this;55                }56                //===============================================================================================57                // DevOps devOpsEnumBuilder builders58                setConfigFromFile(filename) {59                    internal(this).devOpsEnumBuilder.setConfigFromFile(filename);60                    return this61                }62                setPersonalAccessToken(pat) {63                    internal(this).devOpsEnumBuilder.setPersonalAccessToken(pat);64                    return this65                }66                setOrgaization(organization) {67                    internal(this).devOpsEnumBuilder.setOrgaization(organization);68                    return this69                }70                setProject(project) {71                    internal(this).devOpsEnumBuilder.setProject(project);72                    return this73                }74                useDefaultFilter(nameParser) {75                    internal(this).devOpsEnumBuilder.useDefaultFilter(nameParser);76                    return this77                }78                79                addAttachment(id, filename, filter, responseType) {80                    internal(this).devOpsEnumBuilder.addAttachment(id, filename, filter, responseType);81                    return this82                }83                retrieveEnvironmentVariables() {84                    internal(this).devOpsEnumBuilder.retrieveEnvironmentVariables();85                    return this86                }                87                //===============================================================================================88                // EntModeller builders89                addEntityOverrides(overrides) {90                    internal(this).entModellerBuilder.addEntityOverrides(overrides);91                    return this92                }93                addEntityFills(fills) {94                    internal(this).entModellerBuilder.addEntityFills(fills);95                    return this96                }97                addRelationshipFills(fills) {98                    internal(this).entModellerBuilder.addRelationshipFills(fills);99                    return this100                }101                outputAsDOTDefaultServices(styles) {102                    internal(this).entModellerBuilder.outputAsDOTDefaultServices(styles);103                    return this104                }105                outputAsDOT(serviceShapes, styles) {106                    internal(this).entModellerBuilder.outputAsDOT(serviceShapes, styles);107                    return this108                }109                build() {110                    var tracer = new DevOpsModeller(internal(this).devOpsEnumBuilder, internal(this).entModellerBuilder, internal(this).attachmentMappers, internal(this).releaseMappers, internal(this).environmentMappers, internal(this).transformers, internal(this).PreflightBuilder.build());111                    return tracer;112                }113            }114            class PreflightBuilder {115                constructor() {116                    internal(this).attachmentChecks = [];117                    internal(this).environmentChecks = [];118                    internal(this).releaseChecks = [];119                }120                setInitialPayload(initialValue) {121                    internal(this).initialValue = initialValue;122                    return this;123                }124                addAttachmentChecks(id, checker) {125                    internal(this).attachmentChecks.push({id: id, checker: checker});126                    return this;127                }128                addReleaseChecks(checker) {129                    internal(this).releaseChecks.push({checker: checker});130                    return this;131                }132                addEnvironmentChecks(checker) {133                    internal(this).environmentChecks.push({checker: checker});134                    return this;135                }136                build() {137                    return {138                        payload: internal(this).initialValue, 139                        envChecks: internal(this).environmentChecks, 140                        attChecks: internal(this).attachmentChecks, 141                        relChecks: internal(this).releaseChecks142                    }143                }144            }145            return Builder146        }147        async modelDevOps() {148            let results = devopsmodeller(internal(this).devOpsEnumBuilder, internal(this).entModellerBuilder, internal(this).attachmentMappers, internal(this).releaseMappers, internal(this).environmentMappers, internal(this).transformers, internal(this).preflightChecks);149            return results;150        }151    }152    return DevOpsModeller153}())154module.exports = {155    Builder: DevOpsModeller.Builder,156    mappers: require('./Helpers'),157    DotShapes: ent.EntModeller.DotShapes...

1class myAzureSource {2    constructor(devOpsEnum, attachmentMappers, releaseMappers, environmentMappers, transformers, preflightChecks) {3        this.devOpsEnum = devOpsEnum;4        this.attachmentMappers = attachmentMappers;5        this.releaseMappers = releaseMappers;6        this.environmentMappers = environmentMappers;7        this.transformers = transformers8        this.preflightChecks = preflightChecks;9    }10    generateSourceConnections() {11        return new Promise((resolve, reject) => {12            resolve(enumerateAzureReleases(this.devOpsEnum, this.attachmentMappers, this.releaseMappers, this.environmentMappers, this.transformers, this.preflightChecks))13        });14    }15}16async function modelAzureReleases(devOpsEnumBuilder, entModellerBuilder, attachmentMappers, releaseMappers, environmentMappers, transformers, preflightChecks) {17    var enumerator = devOpsEnumBuilder.latestReleasesOnly().build();18    var modeller = entModellerBuilder        19        .addSource("Azure", new myAzureSource(enumerator, attachmentMappers, releaseMappers, environmentMappers, transformers, preflightChecks), null)20        .build();21    let output = await modeller.generateOutput();22    return output;23}24async function enumerateAzureReleases(devOpsEnum, attachmentMappers, releaseMappers, environmentMappers, transformers, preflightChecks) {25    let allReleases = await devOpsEnum.enumerateDevOps()26    let releases = allReleases.reduce((acc, val) => acc.concat(val.items), []);27    // console.log('---------------------------------------------------------------')28    // console.log(JSON.stringify(releases));29    // console.log('---------------------------------------------------------------')30    let releasesWithAttachments = releases.filter(r => r.attachments.size > 0);31    let releasesWithEnvironment = releases.filter(r => r.environment?.variables != null);32    let results = [];33    let payload = preflightChecks?.payload;34    // call preflight checks35    //=======================================================36    preflightChecks.attChecks.forEach(checker => {37        let matches = releasesWithAttachments.filter(r => r.attachments.has(checker.id));38        matches.forEach(m => {39            let attachment = m.attachments.get(checker.id);40            checker.checker(payload, m.release, attachment, m.environment?.variables);41        });42    });43    preflightChecks.envChecks.forEach(checker => {44        releasesWithEnvironment.forEach(m => {45            checker.checker(payload, m.release, m.environment?.variables);46        });47    });48    preflightChecks.relChecks.forEach(checker => {49        releases.forEach(m => {50            checker.checker(payload, m.release, m.environment?.variables);51        });52    });53    // call mappers54    //===================================================55    attachmentMappers.forEach(mapper => {56        let matches = releasesWithAttachments.filter(r => r.attachments.has(mapper.id));57        matches.forEach(m => {58            let attachment = m.attachments.get(mapper.id);59            let mapped = mapper.mapper(payload, m.release, attachment, m.environment?.variables);60            if (mapped != null) {61                if (Array.isArray(mapped))62                    results = results.concat(mapped);63                else64                    results.push(mapped);65            }66        });67    });68    environmentMappers.forEach(mapper => {69        releasesWithEnvironment.forEach(m => {70            let mapped = mapper.mapper(payload, m.release, m.environment?.variables);71            if (mapped != null) {72                if (Array.isArray(mapped))73                    results = results.concat(mapped);74                else75                    results.push(mapped);76            }77        });78    });79    releaseMappers.forEach(mapper => {80        let mapped = mapper.mapper(payload, m.release, m.environment?.variables, r.attachments);81        if (mapped != null) {82            if (Array.isArray(mapped))83                results = results.concat(mapped);84            else85                results.push(mapped);86        }87    });88    //transform all the names89    results.forEach(r => {90        transformers.forEach(t => {91            r.from.name = t(r.from.name);92            r.to.name = t(r.to.name);93        })94    });95    return results;96}...

...86  if (!args) {87    args = parser.parseArgs();88  }89  await logsinkInit(args);90  await preflightChecks(parser, args);91  await logStartupInfo(parser, args);92  let router = getAppiumRouter(args);93  let server = await baseServer(router, args.port, args.address);94  try {95    // TODO prelaunch if args.launch is set96    // TODO: startAlertSocket(server, appiumServer);97    // configure as node on grid, if necessary98    if (args.nodeconfig !== null) {99      await registerNode(args.nodeconfig, args.address, args.port);100    }101  } catch (err) {102    server.close();103    throw err;104  }...

1import _ from 'underscore';2import { createTestHook } from 'util/test_support';3import React from 'react';4import PropTypes from 'prop-types';5import Success from '@splunk/react-icons/Success';6import Error from '@splunk/react-icons/Error';7import Button from '@splunk/react-ui/Button';8import Heading from '@splunk/react-ui/Heading';9import Menu from '@splunk/react-ui/Menu';10import WaitSpinner from '@splunk/react-ui/WaitSpinner';11import css from './WorkloadManagement.pcssm';12const PreflightChecks = (props) => {13    const {14        enableSettingsViewBtn,15        handleReRunPreflightCheck,16        handleShowSettingsView,17        isPreflightCheckLoading,18        checks,19    } = props;20    return (21        <div {...createTestHook(module.id)} className={css.table}>22            <Heading className={`${css.preFlightCheckHeading}`}>23                {_('Preflight Checks').t()}24            </Heading>25            <Menu>26                {checks.map(row => (27                    <Menu.Item28                        className={`${row.id} ${css.preFlightCheckMenuBtn}`}29                        description={row.preflight_check_status ? '' : _(row.mitigation).t()}30                        key={row.id}31                    >32                        {row.preflight_check_status ?33                            <div className={css.successIcon}>34                                <Success size="21px" />35                                &nbsp;{_(row.title).t()}36                            </div>37                            :38                            <div className={css.errorIcon}>39                                <Error size="21px" />40                                &nbsp;{_(row.title).t()}41                            </div>42                        }43                    </Menu.Item>44                ))}45            </Menu>46            <Button47                style={{ marginTop: '5px' }}48                label={_('Rerun preflight checks').t()}49                onClick={handleReRunPreflightCheck}50            />51            <Button52                style={{ marginTop: '5px' }}53                disabled={!enableSettingsViewBtn}54                label={_('Settings View').t()}55                onClick={handleShowSettingsView}56                appearance="primary"57            />58            {isPreflightCheckLoading ?59                <WaitSpinner size="medium" style={{ padding: '6px' }} /> :60                null61            }62        </div>63    );64};65PreflightChecks.propTypes = {66    enableSettingsViewBtn: PropTypes.bool.isRequired,67    handleReRunPreflightCheck: PropTypes.func.isRequired,68    handleShowSettingsView: PropTypes.func.isRequired,69    isPreflightCheckLoading: PropTypes.bool.isRequired,70    checks: PropTypes.arrayOf(PropTypes.shape({})).isRequired,71};...

...27ProcessHandler.startTimer = () => {28  global.setInterval(ProcessHandler.runTasks, Config.processHandler.timerLength)29}30ProcessHandler.runTasks = () => { // TODO: Complete this function31  ProcessHandler.preflightChecks()32  .then(() => {33  })34  .catch((err) => {35    ProcessHandler.setTimerPaused(true)36    Logger.writeLog('PH_002', 'Failed to pass preflightChecks', err, true)37  })38}39ProcessHandler.preflightChecks = () => { // TODO: Complete this function40  return new Promise((fulfill, reject) => {41    if (!ProcessHandler.timerPaused && !ProcessHandler.tasksRunning) {42      fulfill()43    } else {44      reject(new Error('Preflight checks failed'))45    }...

...8  });9  it('should fail when path to inkscape is invalid', () => {10    config.pathToInkscape = '/some/random/stuff/that/will/never/exist';11    expect(() => {12      utils.preflightChecks(config);13    }).to.throw();14  });15  it('should fail when input directory is invalid', () => {16    config.inputDirectory = '/some/random/stuff/that/will/never/exist';17    expect(() => {18      utils.preflightChecks(config);19    }).to.throw();20  });21  it('should fail when output directory is invalid', () => {22    config.outputDirectory = '/some/random/stuff/that/will/never/exist';23    expect(() => {24      utils.preflightChecks(config);25    }).to.throw();26  });27  it('should fail when input is defined, but output not', () => {28    config.inputDirectory = __dirname + '/input';29    expect(() => {30      utils.preflightChecks(config);31    }).to.throw();32  });33  it('should work when input & output directory is defined', () => {34    config.outputDirectory = __dirname + '/output';35    config.inputDirectory = __dirname + '/input';36    expect(() => {37      utils.preflightChecks(config);38    }).to.not.throw();39  });...

1const defaultConfig = require('./defaultConfig');2const preflightChecks = require('./preflightChecks');3const commandParser = require('./commandParser');4const svg2pdf = require('./svg2pdf');5exports.preflightChecks = preflightChecks;6exports.defaultConfig = defaultConfig;7exports.commandParser = commandParser;...