feat: remove SDK generation (#705)

* feat(sdkgen): start removing sdkgen support * test(sdkgen): update more tests * feat(sdkgen): start removing bff prompting * feat(sdkgen): remove unused helper * build(sdkgen): remove unused dependencies
IBM-Swift · Aug 6, 2019 · 08a5efd · 08a5efd
1 parent 821a06f
commit 08a5efd
Show file tree

Hide file tree

Showing 18 changed files with 2 additions and 1,622 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -30,7 +30,6 @@ script:
 - projectName="$(basename $projectFolder)"
 - export SWIFT_SNAPSHOT=swift-5.0
 - source ./Package-Builder/install-swift.sh
-- if [[ $TRAVIS_EVENT_TYPE == "cron" ]]; then npm run testsdkgen; fi
 - if [[ $TRAVIS_EVENT_TYPE != "cron" ]]; then npm run coverage && npm run report-coverage; fi
 jobs:
   include:

diff --git a/app/index.js b/app/index.js
@@ -27,7 +27,6 @@ var validateDirName = helpers.validateDirName
 var validateAppName = helpers.validateAppName
 var validateCredential = helpers.validateRequiredCredential
 var validatePort = helpers.validatePort
-var validateFilePathOrURL = helpers.validateFilePathOrURL
 var generateServiceName = helpers.generateServiceName
 
 module.exports = Generator.extend({
@@ -331,14 +330,13 @@ module.exports = Generator.extend({
         name: 'appPattern',
         type: 'list',
         message: 'Select capability presets for application pattern:',
-        choices: [ 'Basic', 'Web', 'Backend for frontend' ],
+        choices: [ 'Basic', 'Web' ],
         default: 'Basic'
       }]
       return this.prompt(prompts).then((answers) => {
         switch (answers.appPattern) {
           case 'Basic': this.appPattern = 'Basic'; break
           case 'Web': this.appPattern = 'Web'; break
-          case 'Backend for frontend': this.appPattern = 'BFF'; break
           default:
             this.env.error(chalk.red(`Internal error: unknown application pattern ${answers.appPattern}`))
         }
@@ -372,13 +370,6 @@ module.exports = Generator.extend({
             'Embedded metrics dashboard',
             'Docker files'
           ]
-          case 'BFF': return [
-            'Swagger UI',
-            'Embedded metrics dashboard',
-            'Static web file serving',
-            'Docker files',
-            'Kitura OpenAPI'
-          ]
           default:
             self.env.error(chalk.red(`Internal error: unknown application pattern ${appPattern}`))
         }
@@ -407,126 +398,6 @@ module.exports = Generator.extend({
       })
     },
 
-    promptGenerateEndpoints: function () {
-      if (this.skipPrompting) return
-      if (this.appType !== 'scaffold') return
-
-      var choices = [ 'Swagger file serving endpoint', 'Endpoints from swagger file' ]
-      var defaults = this.appPattern === 'BFF' ? choices : []
-
-      var prompts = [{
-        name: 'endpoints',
-        type: 'checkbox',
-        message: 'Select endpoints to generate:',
-        choices: choices,
-        default: defaults
-      }]
-      return this.prompt(prompts).then((answers) => {
-        if (answers.endpoints) {
-          if (answers.endpoints.indexOf('Swagger file serving endpoint') !== -1) {
-            this.hostSwagger = true
-          }
-          if (answers.endpoints.indexOf('Endpoints from swagger file') !== -1) {
-            this.swaggerEndpoints = true
-          }
-        }
-      })
-    },
-
-    promptSwaggerEndpoints: function () {
-      if (this.skipPrompting) return
-      if (this.appType !== 'scaffold') return
-      if (!this.swaggerEndpoints) return
-
-      var choices = {'customSwagger': 'Custom swagger file',
-        'exampleEndpoints': 'Example swagger file'}
-
-      var prompts = [{
-        name: 'swaggerChoice',
-        type: 'list',
-        message: 'Swagger file to use to create endpoints and companion iOS SDK:',
-        choices: [choices.customSwagger, choices.exampleEndpoints],
-        default: choices.customSwagger
-      }, {
-        name: 'path',
-        type: 'input',
-        message: 'Provide the path to a swagger file:',
-        filter: (response) => response.trim(),
-        validate: (response) => validateFilePathOrURL(response, this.initialWorkingDir),
-        when: (question) => (question.swaggerChoice === choices.customSwagger)
-      }, {
-        name: 'generateCodableRoutes',
-        type: 'confirm',
-        message: 'Would you like to generate codable routes, (yes recommended)?',
-        default: true
-      }]
-      return this.prompt(prompts).then((answers) => {
-        this.generateCodableRoutes = answers.generateCodableRoutes
-        if (answers.swaggerChoice === choices.exampleEndpoints) {
-          this.exampleEndpoints = true
-        } else if (answers.path) {
-          var httpPattern = new RegExp(/^https?:\/\/\S+/)
-
-          if (httpPattern.test(answers.path)) {
-            this.fromSwagger = answers.path
-          } else {
-            this.fromSwagger = path.resolve(this.initialWorkingDir, answers.path)
-          }
-        }
-      })
-    },
-
-    promptSwiftServerSwaggerFiles: function () {
-      if (this.skipPrompting) return
-      this.log(chalk.magenta('Service prompts'))
-
-      var depth = 0
-      var prompts = [{
-        name: 'serverSwaggerInput' + depth,
-        type: 'confirm',
-        message: 'Would you like to generate a Swift server SDK from a Swagger file?',
-        default: false
-      }, {
-        when: (props) => props[Object.keys(props)[0]],
-        name: 'serverSwaggerInputPath' + depth,
-        type: 'input',
-        message: 'Enter Swagger yaml file path:',
-        filter: (response) => response.trim(),
-        validate: (response) => validateFilePathOrURL(response, this.initialWorkingDir)
-      }]
-
-      // Declaring a function to handle the answering of these prompts so that
-      // we can repeat them until the user responds that they do not want to
-      // generate any more SDKs
-      var handleAnswers = (answers) => {
-        // Creating and accessing dynamic answer keys for yeoman-test compatability.
-        // It needs unique keys in order to simulate the generation of multiple swagger file paths.
-        if (!answers['serverSwaggerInput' + depth]) {
-          // Sentinel blank value to end looping
-          return
-        }
-
-        if (this.serverSwaggerFiles === undefined) {
-          this.serverSwaggerFiles = []
-        }
-        if (this.serverSwaggerFiles.indexOf(answers['serverSwaggerInputPath' + depth]) === -1) {
-          this.serverSwaggerFiles.push(answers['serverSwaggerInputPath' + depth])
-        } else {
-          this.log(chalk.yellow('This Swagger file is already being used'))
-        }
-        depth += 1
-        prompts[0].name = prompts[0].name.slice(0, -1) + depth
-        prompts[1].name = prompts[1].name.slice(0, -1) + depth
-        prompts[0].message = 'Would you like to generate another Swift server SDK from a Swagger file?'
-        // Now we have processed the response, we need to ask if the user
-        // wants to add any more SDKs. We do this by returning a new
-        // promise here, which will be resolved before the promise
-        // in which it is nested is resolved.
-        return this.prompt(prompts).then(handleAnswers)
-      }
-      return this.prompt(prompts).then(handleAnswers)
-    },
-
     promptServicesForScaffold: function () {
       if (this.skipPrompting) return
       if (this.appType !== 'scaffold') return

diff --git a/config.js b/config.js
diff --git a/lib/helpers.js b/lib/helpers.js
@@ -78,33 +78,6 @@ exports.validatePort = function (port) {
   return true
 }
 
-/**
- * Validate a path, permit paths starting with 'filename' or '/' or './' or '../' or 'http://' or 'https://'. Empty path will not pass.
- * @param {String} path - The user input for a file path either local or remote.
- * @returns {String|Boolean} - Returns error string for invalid path, true for valid path.
- */
-exports.validateFilePathOrURL = function (filePathOrURL, relativeToDir) {
-  if (!filePathOrURL) {
-    return 'Path is required'
-  }
-
-  // ensure file actually exists if using local file path
-  var localMatch = /^\w+|^\/|^\.\.?\//.test(filePathOrURL)
-  var remoteMatch = /^https?:\/\/\S+/.test(filePathOrURL)
-  if (localMatch && remoteMatch) {
-    return true
-  } else if (localMatch && !remoteMatch) {
-    var filePath = filePathOrURL
-    // if file path is relative resolve it against relativeToDir
-    // or the current working directory if relativeToDir is falsy
-    if (!path.isAbsolute(filePathOrURL)) {
-      filePath = path.resolve(relativeToDir || '', filePathOrURL)
-    }
-    return fs.existsSync(filePath) ? true : format('The following path does not exist: %s', path)
-  }
-  return format('The following is not a valid path: %s', filePathOrURL)
-}
-
 /**
  * Validate the application (module) name.
  * @param {String} name - The user input for application name.