Skip to content

Commit

Permalink
Adds new accumulo command (#5073)
Browse files Browse the repository at this point in the history
* Adds new accumulo command:

Adds new `accumulo check-accumulo-properties` command which checks the provided Accumulo configuration file for errors. Only checks the file contents, and not any running instance, so useful for verifying config prior to init. Performs a subset of the checks that `accumulo check-server-config` does. Useful for (at least mostly) validating the `accumulo.properties` file without a running instance.

Co-authored-by: Christopher Tubbs <ctubbsii@apache.org>
  • Loading branch information
kevinrr888 and ctubbsii authored Dec 16, 2024
1 parent 78cbdbe commit 7b8b213
Showing 1 changed file with 66 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* 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
*
* https://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.server.conf;

import java.io.File;
import java.io.IOException;

import org.apache.accumulo.core.conf.SiteConfiguration;
import org.apache.accumulo.server.ServerDirs;
import org.apache.accumulo.server.fs.VolumeManagerImpl;
import org.apache.accumulo.start.spi.KeywordExecutable;
import org.apache.hadoop.conf.Configuration;

import com.google.auto.service.AutoService;
import com.google.common.base.Preconditions;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

@AutoService(KeywordExecutable.class)
public class CheckAccumuloProperties implements KeywordExecutable {

@SuppressFBWarnings(value = "PATH_TRAVERSAL_IN", justification = "intentional user-provided path")
public static void main(String[] args) throws IOException {
Preconditions.checkArgument(args.length == 1,
"Expected 1 argument (the properties file path), got " + args.length);
var hadoopConfig = new Configuration();
var siteConfig = SiteConfiguration.fromFile(new File(args[0])).build();

VolumeManagerImpl.get(siteConfig, hadoopConfig);
new ServerDirs(siteConfig, hadoopConfig);
}

@Override
public String keyword() {
return "check-accumulo-properties";
}

@Override
public String description() {
return "Checks the provided Accumulo configuration file for errors. "
+ "This only checks the contents of the file and not any running Accumulo system, "
+ "so it can be used prior to init, but only performs a subset of the checks done by "
+ (new CheckServerConfig().keyword());
}

@Override
public void execute(String[] args) throws Exception {
main(args);
}
}

0 comments on commit 7b8b213

Please sign in to comment.