root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 5 Packages Projects Releases Wiki Activity

KAFKA-4603: Disallow abbreviations in OptionParser constructor 

KAFKA-4603 the command parsed error
Using "new OptionParser" might result in parse error

Change all the OptionParser constructor in Kafka into "new OptionParser(false)"

Author: xinlihua <xin.lihua1@zte.com.cn>
Author: unknown <00067310@A23338408.zte.intra>
Author: auroraxlh <xin.lihua1@zte.com.cn>
Author: xin <xin.lihua1@zte.com.cn>

Reviewers: Damian Guy, Guozhang Wang

Closes #2349 from auroraxlh/fix_OptionParser_bug
This commit is contained in:
xinlihua 2017-05-30 13:53:32 -07:00 committed by Guozhang Wang
parent b3788d8dcb
commit f0745cd514
32 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/src/main/scala/kafka/Kafka.scala
View File

@ -29,7 +29,7 @@ import scala.collection.JavaConverters._
object Kafka extends Logging {
def getPropsFromArgs(args: Array[String]): Properties = {
val optionParser = new OptionParser
val optionParser = new OptionParser(false)
val overrideOpt = optionParser.accepts("override", "Optional property that should override values set in server.properties file")
.withRequiredArg()
.ofType(classOf[String])

2
core/src/main/scala/kafka/admin/AclCommand.scala
View File

@ -268,7 +268,7 @@ object AclCommand {
}
class AclCommandOptions(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val authorizerOpt = parser.accepts("authorizer", "Fully qualified class name of the authorizer, defaults to kafka.security.auth.SimpleAclAuthorizer.")
.withRequiredArg
.describedAs("authorizer")

2
core/src/main/scala/kafka/admin/BrokerApiVersionsCommand.scala
View File

@ -64,7 +64,7 @@ object BrokerApiVersionsCommand {
val BootstrapServerDoc = "REQUIRED: The server to connect to."
val CommandConfigDoc = "A property file containing configs to be passed to Admin Client."
val parser = new OptionParser
val parser = new OptionParser(false)
val commandConfigOpt = parser.accepts("command-config", CommandConfigDoc)
.withRequiredArg
.describedAs("command config property file")

2
core/src/main/scala/kafka/admin/ConfigCommand.scala
View File

@ -278,7 +278,7 @@ object ConfigCommand extends Config {
}
class ConfigCommandOptions(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", "REQUIRED: The connection string for the zookeeper connection in the form host:port. " +
"Multiple URLS can be given to allow fail-over.")
.withRequiredArg

2
core/src/main/scala/kafka/admin/ConsumerGroupCommand.scala
View File

@ -713,7 +713,7 @@ object ConsumerGroupCommand extends Logging {
val ResetToLatestDoc = "Reset offsets to latest offset."
val ResetShiftByDoc = "Reset offsets shifting current offset by 'n', where 'n' can be positive or negative"
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", ZkConnectDoc)
.withRequiredArg
.describedAs("urls")

2
core/src/main/scala/kafka/admin/DeleteRecordsCommand.scala
View File

@ -97,7 +97,7 @@ object DeleteRecordsCommand {
"{\"partitions\":\n [{\"topic\": \"foo\", \"partition\": 1, \"offset\": 1}],\n \"version\":1\n}"
val CommandConfigDoc = "A property file containing configs to be passed to Admin Client."
val parser = new OptionParser
val parser = new OptionParser(false)
val bootstrapServerOpt = parser.accepts("bootstrap-server", BootstrapServerDoc)
.withRequiredArg
.describedAs("server(s) to use for bootstrapping")

2
core/src/main/scala/kafka/admin/PreferredReplicaLeaderElectionCommand.scala
View File

@ -28,7 +28,7 @@ import org.apache.kafka.common.security.JaasUtils
object PreferredReplicaLeaderElectionCommand extends Logging {
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val jsonFileOpt = parser.accepts("path-to-json-file", "The JSON file with the list of partitions " +
"for which preferred replica leader election should be done, in the following format - \n" +
"{\"partitions\":\n\t[{\"topic\": \"foo\", \"partition\": 1},\n\t {\"topic\": \"foobar\", \"partition\": 2}]\n}\n" +

2
core/src/main/scala/kafka/admin/ReassignPartitionsCommand.scala
View File

@ -279,7 +279,7 @@ object ReassignPartitionsCommand extends Logging {
}
class ReassignPartitionsCommandOptions(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", "REQUIRED: The connection string for the zookeeper connection in the " +
"form host:port. Multiple URLS can be given to allow fail-over.")

2
core/src/main/scala/kafka/admin/TopicCommand.scala
View File

@ -272,7 +272,7 @@ object TopicCommand extends Logging {
}
class TopicCommandOptions(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", "REQUIRED: The connection string for the zookeeper connection in the form host:port. " +
"Multiple URLS can be given to allow fail-over.")
.withRequiredArg

2
core/src/main/scala/kafka/admin/ZkSecurityMigrator.scala
View File

@ -65,7 +65,7 @@ object ZkSecurityMigrator extends Logging {
def run(args: Array[String]) {
var jaasFile = System.getProperty(JaasUtils.JAVA_LOGIN_CONFIG_PARAM)
val parser = new OptionParser
val parser = new OptionParser(false)
val zkAclOpt = parser.accepts("zookeeper.acl", "Indicates whether to make the Kafka znodes in ZooKeeper secure or unsecure."
+ " The options are 'secure' and 'unsecure'").withRequiredArg().ofType(classOf[String])
val zkUrlOpt = parser.accepts("zookeeper.connect", "Sets the ZooKeeper connect string (ensemble). This parameter " +

2
core/src/main/scala/kafka/tools/ConsoleConsumer.scala
View File

@ -205,7 +205,7 @@ object ConsoleConsumer extends Logging {
}
class ConsumerConfig(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val topicIdOpt = parser.accepts("topic", "The topic id to consume on.")
.withRequiredArg
.describedAs("topic")

2
core/src/main/scala/kafka/tools/ConsoleProducer.scala
View File

@ -133,7 +133,7 @@ object ConsoleProducer {
}
class ProducerConfig(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val topicOpt = parser.accepts("topic", "REQUIRED: The topic id to produce messages to.")
.withRequiredArg
.describedAs("topic")

2
core/src/main/scala/kafka/tools/ConsumerOffsetChecker.scala
View File

@ -102,7 +102,7 @@ object ConsumerOffsetChecker extends Logging {
def main(args: Array[String]) {
warn("WARNING: ConsumerOffsetChecker is deprecated and will be dropped in releases following 0.9.0. Use ConsumerGroupCommand instead.")
val parser = new OptionParser()
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", "ZooKeeper connect string.").
withRequiredArg().defaultsTo("localhost:2181").ofType(classOf[String])

2
core/src/main/scala/kafka/tools/DumpLogSegments.scala
View File

@ -37,7 +37,7 @@ import scala.collection.JavaConverters._
object DumpLogSegments {
def main(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val printOpt = parser.accepts("print-data-log", "if set, printing the messages content when dumping data logs. Automatically set if any decoder option is specified.")
val verifyOpt = parser.accepts("verify-index-only", "if set, just verify the index log without printing its content.")
val indexSanityOpt = parser.accepts("index-sanity-check", "if set, just checks the index sanity without printing its content. " +

2
core/src/main/scala/kafka/tools/ExportZkOffsets.scala
View File

@ -46,7 +46,7 @@ import scala.collection.JavaConverters._
object ExportZkOffsets extends Logging {
def main(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zkconnect", "ZooKeeper connect string.")
.withRequiredArg()

2
core/src/main/scala/kafka/tools/GetOffsetShell.scala
View File

@ -29,7 +29,7 @@ import kafka.utils.{CommandLineUtils, Exit, ToolsUtils}
object GetOffsetShell {
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val brokerListOpt = parser.accepts("broker-list", "REQUIRED: The list of hostname and port of the server to connect to.")
.withRequiredArg
.describedAs("hostname:port,...,hostname:port")

2
core/src/main/scala/kafka/tools/ImportZkOffsets.scala
View File

@ -44,7 +44,7 @@ import org.apache.kafka.common.security.JaasUtils
object ImportZkOffsets extends Logging {
def main(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zkconnect", "ZooKeeper connect string.")
.withRequiredArg()

2
core/src/main/scala/kafka/tools/JmxTool.scala
View File

@ -41,7 +41,7 @@ object JmxTool extends Logging {
def main(args: Array[String]) {
// Parse command line
val parser = new OptionParser
val parser = new OptionParser(false)
val objectNameOpt =
parser.accepts("object-name", "A JMX object name to use as a query. This can contain wild cards, and this option " +
"can be given multiple times to specify more than one query. If no objects are specified " +

2
core/src/main/scala/kafka/tools/MirrorMaker.scala
View File

@ -87,7 +87,7 @@ object MirrorMaker extends Logging with KafkaMetricsGroup {
info("Starting mirror maker")
try {
val parser = new OptionParser
val parser = new OptionParser(false)
val consumerConfigOpt = parser.accepts("consumer.config",
"Embedded consumer config for consuming from the source cluster.")

2
core/src/main/scala/kafka/tools/PerfConfig.scala
View File

@ -21,7 +21,7 @@ import joptsimple.OptionParser
class PerfConfig(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val numMessagesOpt = parser.accepts("messages", "REQUIRED: The number of messages to send or consume")
.withRequiredArg
.describedAs("count")

2
core/src/main/scala/kafka/tools/ReplayLogProducer.scala
View File

@ -61,7 +61,7 @@ object ReplayLogProducer extends Logging {
}
class Config(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper", "REQUIRED: The connection string for the zookeeper connection in the form host:port. " +
"Multiple URLS can be given to allow fail-over.")
.withRequiredArg

2
core/src/main/scala/kafka/tools/ReplicaVerificationTool.scala
View File

@ -65,7 +65,7 @@ object ReplicaVerificationTool extends Logging {
}
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val brokerListOpt = parser.accepts("broker-list", "REQUIRED: The list of hostname and port of the server to connect to.")
.withRequiredArg
.describedAs("hostname:port,...,hostname:port")

2
core/src/main/scala/kafka/tools/SimpleConsumerShell.scala
View File

@ -38,7 +38,7 @@ object SimpleConsumerShell extends Logging {
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val brokerListOpt = parser.accepts("broker-list", "REQUIRED: The list of hostname and port of the server to connect to.")
.withRequiredArg
.describedAs("hostname:port,...,hostname:port")

2
core/src/main/scala/kafka/tools/StateChangeLogMerger.scala
View File

@ -60,7 +60,7 @@ object StateChangeLogMerger extends Logging {
def main(args: Array[String]) {
// Parse input arguments.
val parser = new OptionParser
val parser = new OptionParser(false)
val filesOpt = parser.accepts("logs", "Comma separated list of state change logs or a regex for the log file names")
.withRequiredArg
.describedAs("file1,file2,...")

3
core/src/main/scala/kafka/tools/StreamsResetter.java
View File

@ -137,7 +137,8 @@ public class StreamsResetter {
}
private void parseArguments(final String[] args) throws IOException {
final OptionParser optionParser = new OptionParser();
final OptionParser optionParser = new OptionParser(false);
applicationIdOption = optionParser.accepts("application-id", "The Kafka Streams application ID (application.id).")
.withRequiredArg()
.ofType(String.class)

2
core/src/main/scala/kafka/tools/VerifyConsumerRebalance.scala
View File

@ -23,7 +23,7 @@ import kafka.utils.{CommandLineUtils, Exit, Logging, ZKGroupTopicDirs, ZkUtils}
object VerifyConsumerRebalance extends Logging {
def main(args: Array[String]) {
val parser = new OptionParser()
val parser = new OptionParser(false)
val zkConnectOpt = parser.accepts("zookeeper.connect", "ZooKeeper connect string.").
withRequiredArg().defaultsTo("localhost:2181").ofType(classOf[String])

2
core/src/test/scala/kafka/tools/TestLogCleaning.scala
View File

@ -49,7 +49,7 @@ import scala.collection.JavaConverters._
object TestLogCleaning {
def main(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val numMessagesOpt = parser.accepts("messages", "The number of messages to send or consume.")
.withRequiredArg
.describedAs("count")

2
core/src/test/scala/other/kafka/TestLinearWriteSpeed.scala
View File

@ -38,7 +38,7 @@ import scala.math._
object TestLinearWriteSpeed {
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val dirOpt = parser.accepts("dir", "The directory to write to.")
.withRequiredArg
.describedAs("path")

2
core/src/test/scala/other/kafka/TestOffsetManager.scala
View File

@ -197,7 +197,7 @@ object TestOffsetManager {
}
def main(args: Array[String]) {
val parser = new OptionParser
val parser = new OptionParser(false)
val zookeeperOpt = parser.accepts("zookeeper", "The ZooKeeper connection URL.")
.withRequiredArg
.describedAs("ZooKeeper URL")

2
core/src/test/scala/other/kafka/TestPurgatoryPerformance.scala
View File

@ -36,7 +36,7 @@ import scala.collection.JavaConverters._
object TestPurgatoryPerformance {
def main(args: Array[String]): Unit = {
val parser = new OptionParser
val parser = new OptionParser(false)
val keySpaceSizeOpt = parser.accepts("key-space-size", "The total number of possible keys")
.withRequiredArg
.describedAs("total_num_possible_keys")

4
docs/security.html
View File

@ -908,11 +908,11 @@
</ol>
Here is an example of how to run the migration tool:
<pre>
./bin/zookeeper-security-migration --zookeeper.acl=secure --zookeeper.connect=localhost:2181
./bin/zookeeper-security-migration.sh --zookeeper.acl=secure --zookeeper.connect=localhost:2181
</pre>
<p>Run this to see the full list of parameters:</p>
<pre>
./bin/zookeeper-security-migration --help
./bin/zookeeper-security-migration.sh --help
</pre>
<h4><a id="zk_authz_ensemble" href="#zk_authz_ensemble">7.6.3 Migrating the ZooKeeper ensemble</a></h4>
It is also necessary to enable authentication on the ZooKeeper ensemble. To do it, we need to perform a rolling restart of the server and set a few properties. Please refer to the ZooKeeper documentation for more detail:

4
streams/src/test/java/org/apache/kafka/streams/integration/ResetIntegrationTest.java
View File

@ -340,7 +340,7 @@ public class ResetIntegrationTest {
if (intermediateUserTopic != null) {
parameters = new String[]{
"--application-id", APP_ID + testNo,
"--bootstrap-server", CLUSTER.bootstrapServers(),
"--bootstrap-servers", CLUSTER.bootstrapServers(),
"--zookeeper", CLUSTER.zKConnectString(),
"--input-topics", INPUT_TOPIC,
"--intermediate-topics", INTERMEDIATE_USER_TOPIC
@ -348,7 +348,7 @@ public class ResetIntegrationTest {
} else {
parameters = new String[]{
"--application-id", APP_ID + testNo,
"--bootstrap-server", CLUSTER.bootstrapServers(),
"--bootstrap-servers", CLUSTER.bootstrapServers(),
"--zookeeper", CLUSTER.zKConnectString(),
"--input-topics", INPUT_TOPIC
};