Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clean up CLI parsing and stop depending on Accumulo internals (#61)
* Remove dependencies on Accumulo internal CLI parsing code by addeing ClientOpts and Help * Remove trace code from TestIngest
- Loading branch information
Showing
19 changed files
with
362 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
213 changes: 213 additions & 0 deletions
213
src/main/java/org/apache/accumulo/testing/cli/ClientOpts.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
| package org.apache.accumulo.testing.cli; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| import java.io.FileInputStream; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.net.URL; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.Properties; | ||
|
|
||
| import org.apache.accumulo.core.client.Accumulo; | ||
| import org.apache.accumulo.core.client.AccumuloClient; | ||
| import org.apache.accumulo.core.client.security.tokens.AuthenticationToken; | ||
| import org.apache.accumulo.core.conf.ClientProperty; | ||
| import org.apache.accumulo.core.conf.ConfigurationTypeHelper; | ||
| import org.apache.accumulo.core.security.Authorizations; | ||
| import org.apache.accumulo.core.security.ColumnVisibility; | ||
| import org.apache.log4j.Level; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import com.beust.jcommander.IStringConverter; | ||
| import com.beust.jcommander.Parameter; | ||
|
|
||
| public class ClientOpts extends Help { | ||
|
|
||
| public static class TimeConverter implements IStringConverter<Long> { | ||
| @Override | ||
| public Long convert(String value) { | ||
| return ConfigurationTypeHelper.getTimeInMillis(value); | ||
| } | ||
| } | ||
|
|
||
| public static class AuthConverter implements IStringConverter<Authorizations> { | ||
| @Override | ||
| public Authorizations convert(String value) { | ||
| return new Authorizations(value.split(",")); | ||
| } | ||
| } | ||
|
|
||
| public static class Password { | ||
| public byte[] value; | ||
|
|
||
| public Password(String dfault) { | ||
| value = dfault.getBytes(UTF_8); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return new String(value, UTF_8); | ||
| } | ||
| } | ||
|
|
||
| public static class PasswordConverter implements IStringConverter<Password> { | ||
| @Override | ||
| public Password convert(String value) { | ||
| return new Password(value); | ||
| } | ||
| } | ||
|
|
||
| public static class VisibilityConverter implements IStringConverter<ColumnVisibility> { | ||
| @Override | ||
| public ColumnVisibility convert(String value) { | ||
| return new ColumnVisibility(value); | ||
| } | ||
| } | ||
|
|
||
| @Parameter(names = {"-u", "--user"}, description = "Connection user") | ||
| private String principal = null; | ||
|
|
||
| @Parameter(names = "-p", converter = PasswordConverter.class, description = "Connection password") | ||
| private Password password = null; | ||
|
|
||
| @Parameter(names = "--password", converter = PasswordConverter.class, | ||
| description = "Enter the connection password", password = true) | ||
| private Password securePassword = null; | ||
|
|
||
| public AuthenticationToken getToken() { | ||
| return ClientProperty.getAuthenticationToken(getClientProperties()); | ||
| } | ||
|
|
||
| @Parameter(names = {"-z", "--keepers"}, | ||
| description = "Comma separated list of zookeeper hosts (host:port,host:port)") | ||
| protected String zookeepers = null; | ||
|
|
||
| @Parameter(names = {"-i", "--instance"}, description = "The name of the accumulo instance") | ||
| protected String instance = null; | ||
|
|
||
| @Parameter(names = {"-auths", "--auths"}, converter = AuthConverter.class, | ||
| description = "the authorizations to use when reading or writing") | ||
| public Authorizations auths = Authorizations.EMPTY; | ||
|
|
||
| @Parameter(names = "--debug", description = "turn on TRACE-level log messages") | ||
| public boolean debug = false; | ||
|
|
||
| @Parameter(names = "--ssl", description = "Connect to accumulo over SSL") | ||
| private boolean sslEnabled = false; | ||
|
|
||
| @Parameter(names = "--sasl", description = "Connecto to Accumulo using SASL (supports Kerberos)") | ||
| private boolean saslEnabled = false; | ||
|
|
||
| @Parameter(names = "--config-file", description = "Read the given client config file. " | ||
| + "If omitted, the classpath will be searched for file named accumulo-client.properties") | ||
| private String clientConfigFile = null; | ||
|
|
||
| public void startDebugLogging() { | ||
| if (debug) | ||
| Logger.getLogger("org.apache.accumulo.testing").setLevel(Level.TRACE); | ||
| } | ||
|
|
||
| @Parameter(names = "--trace", description = "turn on distributed tracing") | ||
| public boolean trace = false; | ||
|
|
||
| @Parameter(names = "--keytab", description = "Kerberos keytab on the local filesystem") | ||
| private String keytabPath = null; | ||
|
|
||
| @Override | ||
| public void parseArgs(String programName, String[] args, Object... others) { | ||
| super.parseArgs(programName, args, others); | ||
| startDebugLogging(); | ||
| } | ||
|
|
||
| private Properties cachedProps = null; | ||
|
|
||
| public String getPrincipal() { | ||
| return ClientProperty.AUTH_PRINCIPAL.getValue(getClientProperties()); | ||
| } | ||
|
|
||
| public void setPrincipal(String principal) { | ||
| this.principal = principal; | ||
| } | ||
|
|
||
| public void setClientProperties(Properties clientProps) { | ||
| this.cachedProps = clientProps; | ||
| } | ||
|
|
||
| /** | ||
| * @return {@link AccumuloClient} that must be closed by user | ||
| */ | ||
| public AccumuloClient createClient() { | ||
| return Accumulo.newClient().from(getClientProperties()).build(); | ||
| } | ||
|
|
||
| public String getClientConfigFile() { | ||
| if (clientConfigFile == null) { | ||
| URL clientPropsUrl = ClientOpts.class.getClassLoader().getResource( | ||
| "accumulo-client.properties"); | ||
| if (clientPropsUrl != null) { | ||
| clientConfigFile = clientPropsUrl.getFile(); | ||
| } | ||
| } | ||
| return clientConfigFile; | ||
| } | ||
|
|
||
| public Properties getClientProperties() { | ||
| if (cachedProps == null) { | ||
| cachedProps = new Properties(); | ||
| if (getClientConfigFile() != null) { | ||
| cachedProps = toProperties(Paths.get(getClientConfigFile())); | ||
| } | ||
| if (saslEnabled) { | ||
| cachedProps.setProperty(ClientProperty.SASL_ENABLED.getKey(), "true"); | ||
| } | ||
| if (sslEnabled) { | ||
| cachedProps.setProperty(ClientProperty.SSL_ENABLED.getKey(), "true"); | ||
| } | ||
| if (principal != null) { | ||
| cachedProps.setProperty(ClientProperty.AUTH_PRINCIPAL.getKey(), principal); | ||
| } | ||
| if (zookeepers != null) { | ||
| cachedProps.setProperty(ClientProperty.INSTANCE_ZOOKEEPERS.getKey(), zookeepers); | ||
| } | ||
| if (instance != null) { | ||
| cachedProps.setProperty(ClientProperty.INSTANCE_NAME.getKey(), instance); | ||
| } | ||
| if (securePassword != null) { | ||
| ClientProperty.setPassword(cachedProps, securePassword.toString()); | ||
| } else if (password != null) { | ||
| ClientProperty.setPassword(cachedProps, password.toString()); | ||
| } else if (keytabPath != null) { | ||
| ClientProperty.setKerberosKeytab(cachedProps, keytabPath); | ||
| } | ||
| } | ||
| return cachedProps; | ||
| } | ||
|
|
||
| private static Properties toProperties(Path propertiesFile) { | ||
| Properties properties = new Properties(); | ||
| try (InputStream is = new FileInputStream(propertiesFile.toFile())) { | ||
| properties.load(is); | ||
| } catch (IOException e) { | ||
| throw new IllegalArgumentException("Failed to load properties from " + propertiesFile, e); | ||
| } | ||
| return properties; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
| package org.apache.accumulo.testing.cli; | ||
|
|
||
| import com.beust.jcommander.JCommander; | ||
| import com.beust.jcommander.Parameter; | ||
| import com.beust.jcommander.ParameterException; | ||
|
|
||
| public class Help { | ||
| @Parameter(names = {"-h", "-?", "--help", "-help"}, help = true) | ||
| public boolean help = false; | ||
|
|
||
| public void parseArgs(String programName, String[] args, Object... others) { | ||
| JCommander commander = new JCommander(); | ||
| commander.addObject(this); | ||
| for (Object other : others) | ||
| commander.addObject(other); | ||
| commander.setProgramName(programName); | ||
| try { | ||
| commander.parse(args); | ||
| } catch (ParameterException ex) { | ||
| commander.usage(); | ||
| exitWithError(ex.getMessage(), 1); | ||
| } | ||
| if (help) { | ||
| commander.usage(); | ||
| exit(0); | ||
| } | ||
| } | ||
|
|
||
| public void exit(int status) { | ||
| System.exit(status); | ||
| } | ||
|
|
||
| public void exitWithError(String message, int status) { | ||
| System.err.println(message); | ||
| exit(status); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.