hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/ArgBasedConfiguration.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.Either
  23 import arrow.core.Option
  24 import arrow.core.Try
  25 import arrow.core.flatMap
  26 import arrow.core.getOrElse
  27 import org.apache.commons.cli.CommandLine
  28 import org.apache.commons.cli.CommandLineParser
  29 import org.apache.commons.cli.Options
  30 import java.io.File
  31 import java.nio.file.Path
  32 import java.nio.file.Paths
  33
  34 abstract class ArgBasedConfiguration<T>(private val parser: CommandLineParser) {
  35     abstract val cmdLineOptionsList: List<CommandLineOption>
  36
  37     fun parse(args: Array<out String>): Either<WrongArgumentError, T> {
  38         val commandLineOptions = cmdLineOptionsList.map { it.option }.fold(Options(), Options::addOption)
  39         val parseResult = Try {
  40             parser.parse(commandLineOptions, args)
  41         }
  42         return parseResult
  43                 .toEither()
  44                 .mapLeft { ex -> WrongArgumentError(ex, commandLineOptions) }
  45                 .map(this::getConfiguration)
  46                 .flatMap {
  47                     it.toEither {
  48                         WrongArgumentError(
  49                                 "Unexpected error when parsing command line arguments",
  50                                 commandLineOptions)
  51                     }
  52                 }
  53     }
  54
  55     protected abstract fun getConfiguration(cmdLine: CommandLine): Option<T>
  56
  57     protected fun CommandLine.longValue(cmdLineOpt: CommandLineOption, default: Long): Long =
  58             longValue(cmdLineOpt).getOrElse { default }
  59
  60     protected fun CommandLine.stringValue(cmdLineOpt: CommandLineOption, default: String): String =
  61             optionValue(cmdLineOpt).getOrElse { default }
  62
  63     protected fun CommandLine.intValue(cmdLineOpt: CommandLineOption): Option<Int> =
  64             optionValue(cmdLineOpt).map(String::toInt)
  65
  66     private fun CommandLine.longValue(cmdLineOpt: CommandLineOption): Option<Long> =
  67             optionValue(cmdLineOpt).map(String::toLong)
  68
  69     protected fun CommandLine.stringValue(cmdLineOpt: CommandLineOption): Option<String> =
  70             optionValue(cmdLineOpt)
  71
  72     protected fun CommandLine.hasOption(cmdLineOpt: CommandLineOption): Boolean =
  73             this.hasOption(cmdLineOpt.option.opt)
  74
  75     protected fun stringPathToPath(path: String): Path = Paths.get(File(path).toURI())
  76
  77     private fun CommandLine.optionValue(cmdLineOpt: CommandLineOption): Option<String> =
  78             Option.fromNullable(getOptionValue(cmdLineOpt.option.opt))
  79 }