sources/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentError.kt

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * dcaegen2-collectors-veshv
   4  * ================================================================================
   5  * Copyright (C) 2018 NOKIA
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.dcae.collectors.veshv.utils.commandline
  21
  22 import arrow.core.Option
  23 import org.apache.commons.cli.HelpFormatter
  24 import org.apache.commons.cli.Options
  25
  26
  27 data class WrongArgumentError(
  28         val message: String,
  29         val cause: Throwable? = null,
  30         val cmdLineOptionsList: List<CommandLineOption>) {
  31
  32     constructor(par: Throwable, cmdLineOptionsList: List<CommandLineOption>) :
  33             this(par.message ?: "",
  34                     par,
  35                     cmdLineOptionsList)
  36
  37     fun printMessage() {
  38         println(message)
  39     }
  40
  41     fun printHelp(programName: String) {
  42         val formatter = HelpFormatter()
  43         val footer = "All parameters can be specified as environment variables using upper-snake-case full " +
  44                 "name with prefix `VESHV_`."
  45
  46         formatter.printHelp(
  47                 programName,
  48                 generateRequiredParametersNote(cmdLineOptionsList),
  49                 getOptions(),
  50                 footer)
  51     }
  52
  53     private fun getOptions() = cmdLineOptionsList.map { it.option }.fold(Options(), Options::addOption)
  54
  55     companion object {
  56         fun generateRequiredParametersNote(cmdLineOptionsList: List<CommandLineOption>): String {
  57             val requiredParams = Option.fromNullable(cmdLineOptionsList.filter { it.required }
  58                     .takeUnless { it.isEmpty() })
  59             return requiredParams.fold(
  60                     { "" },
  61                     {
  62                         it.map { commandLineOption -> commandLineOption.option.opt }
  63                                 .joinToString(prefix = "Required parameters: ", separator = ", ")
  64                     }
  65             )
  66         }
  67     }
  68
  69 }
  70