index.js

  1. // Copyright 2018 Google Inc. All Rights Reserved.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. //      http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  15. 'use strict';
  17. var proc = require('./lib/process.js')
  18. var compile = require('./lib/compile.js')
  19. var sway = require('sway')
  20. var fs = require('fs')
  21. var join = require('path').join
  22. var merge2 = require('./lib/util').merge2
  24. module.exports = {
  25.   generate: generate
  26. }
  28. /**
  29.  * GenerationResults is the final result of the generation function
  30.  * @typedef {object} GenerationResults
  31.  * @property {compilation.GeneratedTest[]} generated set of generated test objects
  32.  */
  34. /**
  35.  * Generates test artifacts based on the given API Spec and options
  36.  * @function generate
  37.  * @instance
  38.  * @param {string} specPath path to the API spec document
  39.  * @param {object} options options to apply during processing of API spec
  40.  * @return {Promise<GenerationResults>}
  41.  */
  42. function generate(specPath, options) {
  43.   return sway.create({
  44.     'definition': specPath,
  45.     'jsonRefs': options && options.jsonRefs,
  46.     'customFormats': options && options.customFormats,
  47.     'customFormatGenerators': options && options.customFormatGenerators,
  48.     'customValidators': options && options.customValidators
  49.   })
  50.       .then(function (api) {
  51.         if (options.customValues) {
  52.           options.customValues = JSON.parse(options.customValues);
  53.         }
  55.         if (options.customValuesFile) {
  56.           var customFromFile = require(
  57.               join(process.cwd(), options.customValuesFile))
  58.           options.customValues = merge2(options.customValues, customFromFile)
  59.         }
  61.         var processed = proc(api, options)
  62.         var compiled = compile(processed, options)
  64.         if (options.writeTo !== undefined) {
  65.           if (!fs.existsSync(options.writeTo)) {
  66.             fs.mkdirSync(options.writeTo)
  67.           }
  69.           try {
  70.             for (var i = 0; i < compiled.length; i++) {
  71.               const testObj = compiled[i];
  72.               fs.writeFileSync(join(options.writeTo, testObj.filename), testObj.contents)
  73.             }
  74.           } catch (err) {
  75.             console.log(err);
  76.           }
  77.         }
  79.         return {'generated': compiled}
  80.       }, function (err) {
  81.         console.error(err.stack);
  82.         return err
  83.       });
  84. }