From 32aeb329986b3d6b9671c0a9e555cbff43964b3a Mon Sep 17 00:00:00 2001 From: fkrzywka Date: Wed, 13 Jun 2018 10:02:03 +0200 Subject: Refactor ArgBasedConfiguration Extracted duplicate code from Client/Server ArgBasedConfiguration, as it probably would be used third time in future work Change-Id: I581abbcd5f1dd4a1a049e1d28e68a7e4d82a84f8 Signed-off-by: fkrzywka Issue-ID: DCAEGEN2-601 --- hv-collector-utils/pom.xml | 154 +++++++++++---------- .../utils/commandline/ArgBasedConfiguration.kt | 62 +++++++++ .../veshv/utils/commandline/CommandLineOption.kt | 76 ++++++++++ .../utils/commandline/WrongArgumentException.kt | 35 +++++ .../dcae/collectors/veshv/utils/logging/Logger.kt | 2 +- 5 files changed, 253 insertions(+), 76 deletions(-) create mode 100644 hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/ArgBasedConfiguration.kt create mode 100644 hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOption.kt create mode 100644 hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentException.kt (limited to 'hv-collector-utils') diff --git a/hv-collector-utils/pom.xml b/hv-collector-utils/pom.xml index 2adf21a2..8a8a1d8c 100644 --- a/hv-collector-utils/pom.xml +++ b/hv-collector-utils/pom.xml @@ -19,88 +19,92 @@ ~ ============LICENSE_END========================================================= --> - 4.0.0 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 - - - The Apache Software License, Version 2.0 - http://www.apache.org/licenses/LICENSE-2.0.txt - - + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + + - - false - + + false + - - org.onap.dcaegen2.collectors.veshv - ves-hv-collector - 1.0.0-SNAPSHOT - .. - + + org.onap.dcaegen2.collectors.veshv + ves-hv-collector + 1.0.0-SNAPSHOT + .. + - hv-collector-utils - VES HighVolume Collector :: Utilities + hv-collector-utils + VES HighVolume Collector :: Utilities - - - - kotlin-maven-plugin - org.jetbrains.kotlin - - - maven-surefire-plugin - org.apache.maven.plugins - - - + + + + kotlin-maven-plugin + org.jetbrains.kotlin + + + maven-surefire-plugin + org.apache.maven.plugins + + + - - - org.jetbrains.kotlin - kotlin-reflect - - - org.slf4j - slf4j-api - - - com.nhaarman - mockito-kotlin - - - org.mockito - mockito-core - - - org.assertj - assertj-core - - - org.jetbrains.kotlin - kotlin-test - - - org.jetbrains.spek - spek-api - - - org.jetbrains.spek - spek-junit-platform-engine - - - io.projectreactor - reactor-test - - - ch.qos.logback - logback-classic - test - - + + + commons-cli + commons-cli + + + org.jetbrains.kotlin + kotlin-reflect + + + org.slf4j + slf4j-api + + + com.nhaarman + mockito-kotlin + + + org.mockito + mockito-core + + + org.assertj + assertj-core + + + org.jetbrains.kotlin + kotlin-test + + + org.jetbrains.spek + spek-api + + + org.jetbrains.spek + spek-junit-platform-engine + + + io.projectreactor + reactor-test + + + ch.qos.logback + logback-classic + test + + \ No newline at end of file diff --git a/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/ArgBasedConfiguration.kt b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/ArgBasedConfiguration.kt new file mode 100644 index 00000000..968c340f --- /dev/null +++ b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/ArgBasedConfiguration.kt @@ -0,0 +1,62 @@ +/* + * ============LICENSE_START======================================================= + * dcaegen2-collectors-veshv + * ================================================================================ + * Copyright (C) 2018 NOKIA + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.dcae.collectors.veshv.utils.commandline + +import org.apache.commons.cli.CommandLine +import org.apache.commons.cli.CommandLineParser +import org.apache.commons.cli.Options +import java.io.File +import java.nio.file.Paths + +abstract class ArgBasedConfiguration(val parser: CommandLineParser) { + abstract val cmdLineOptionsList: List + + fun parse(args: Array): T { + val commandLineOptions = cmdLineOptionsList.map { it.option }.fold(Options(), Options::addOption) + try { + val cmdLine = parser.parse(commandLineOptions, args) + return getConfiguration(cmdLine) + } catch (ex: Exception) { + throw WrongArgumentException(ex, commandLineOptions) + } + } + + protected abstract fun getConfiguration(cmdLine: CommandLine): T + + protected fun CommandLine.intValue(cmdLineOpt: CommandLineOption): Int = + getOptionValue(cmdLineOpt.option.opt).toInt() + + protected fun CommandLine.intValue(cmdLineOpt: CommandLineOption, default: Int): Int = + getOptionValue(cmdLineOpt.option.opt)?.toInt() ?: default + + protected fun CommandLine.longValue(cmdLineOpt: CommandLineOption): Long = + getOptionValue(cmdLineOpt.option.opt).toLong() + + protected fun CommandLine.longValue(cmdLineOpt: CommandLineOption, default: Long): Long = + getOptionValue(cmdLineOpt.option.opt)?.toLong() ?: default + + protected fun CommandLine.stringValue(cmdLineOpt: CommandLineOption): String = + getOptionValue(cmdLineOpt.option.opt) + + protected fun CommandLine.stringValue(cmdLineOpt: CommandLineOption, default: String): String = + getOptionValue(cmdLineOpt.option.opt) ?: default + + protected fun stringPathToPath(path: String) = Paths.get(File(path).toURI()) +} diff --git a/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOption.kt b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOption.kt new file mode 100644 index 00000000..d36f194d --- /dev/null +++ b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/CommandLineOption.kt @@ -0,0 +1,76 @@ +/* + * ============LICENSE_START======================================================= + * dcaegen2-collectors-veshv + * ================================================================================ + * Copyright (C) 2018 NOKIA + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.dcae.collectors.veshv.utils.commandline + +import org.apache.commons.cli.Option + + +enum class CommandLineOption(val option: Option) { + LISTEN_PORT(Option.builder("p") + .longOpt("listen-port") + .hasArg() + .desc("Listen port") + .build() + ), + CONSUL_CONFIG_URL(Option.builder("c") + .longOpt("config-url") + .hasArg() + .desc("URL of ves configuration on consul") + .build() + ), + VES_HV_PORT(Option.builder("p") + .longOpt("ves-port") + .required() + .hasArg() + .desc("VesHvCollector port") + .build() + ), + VES_HV_HOST(Option.builder("h") + .longOpt("ves-host") + .required() + .hasArg() + .desc("VesHvCollector host") + .build() + ), + MESSAGES_TO_SEND_AMOUNT(Option.builder("m") + .longOpt("messages") + .hasArg() + .desc("Amount of messages to send") + .build() + ), + PRIVATE_KEY_FILE(Option.builder("k") + .longOpt("private-key-file") + .hasArg() + .desc("File with private key in PEM format") + .build() + ), + CERT_FILE(Option.builder("e") + .longOpt("cert-file") + .hasArg() + .desc("File with certificate bundle") + .build() + ), + TRUST_CERT_FILE(Option.builder("t") + .longOpt("trust-cert-file") + .hasArg() + .desc("File with trusted certificate bundle for trusting connections") + .build() + ), +} diff --git a/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentException.kt b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentException.kt new file mode 100644 index 00000000..5f6a86ad --- /dev/null +++ b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/commandline/WrongArgumentException.kt @@ -0,0 +1,35 @@ +/* + * ============LICENSE_START======================================================= + * dcaegen2-collectors-veshv + * ================================================================================ + * Copyright (C) 2018 NOKIA + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.dcae.collectors.veshv.utils.commandline + +import org.apache.commons.cli.HelpFormatter +import org.apache.commons.cli.Options + + +class WrongArgumentException(parent: Exception, private val options: Options) : Exception(parent.message, parent) { + fun printMessage() { + println(message) + } + + fun printHelp(programName: String) { + val formatter = HelpFormatter() + formatter.printHelp(programName, options) + } +} diff --git a/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/logging/Logger.kt b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/logging/Logger.kt index eb52a866..314c9bf9 100644 --- a/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/logging/Logger.kt +++ b/hv-collector-utils/src/main/kotlin/org/onap/dcae/collectors/veshv/utils/logging/Logger.kt @@ -107,4 +107,4 @@ class Logger(val logger: org.slf4j.Logger) { logger.warn(messageProvider(), ex) } } -} \ No newline at end of file +} -- cgit 1.2.3-korg