You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by GitBox <gi...@apache.org> on 2022/01/03 19:11:30 UTC
[GitHub] [cassandra] josh-mckenzie commented on a change in pull request #1370: Make capacity/validity/updateinterval/activeupdate for Auth Caches configurable via nodetool
josh-mckenzie commented on a change in pull request #1370:
URL: https://github.com/apache/cassandra/pull/1370#discussion_r777643724
##########
File path: src/java/org/apache/cassandra/tools/nodetool/GetAuthCacheConfig.java
##########
@@ -0,0 +1,71 @@
+/*
+ * 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.cassandra.tools.nodetool;
+
+import io.airlift.airline.Command;
+import io.airlift.airline.Option;
+import org.apache.cassandra.auth.AuthCacheMBean;
+import org.apache.cassandra.auth.NetworkPermissionsCacheMBean;
+import org.apache.cassandra.auth.PasswordAuthenticator;
+import org.apache.cassandra.auth.PermissionsCacheMBean;
+import org.apache.cassandra.auth.RolesCacheMBean;
+import org.apache.cassandra.auth.jmx.AuthorizationProxy;
+import org.apache.cassandra.tools.NodeProbe;
+import org.apache.cassandra.tools.NodeTool;
+
+@Command(name = "getauthcacheconfig", description = "Get configuration of Auth cache")
+public class GetAuthCacheConfig extends NodeTool.NodeToolCmd
+{
+ @SuppressWarnings("unused")
+ @Option(title = "cache-name",
+ name = {"--cache-name"},
+ description = "Name of Auth cache (required)",
+ required = true)
+ private String cacheName;
+
+ @Override
+ public void execute(NodeProbe probe)
+ {
+ AuthCacheMBean authCacheMBean = getAuthCacheMBean(probe, cacheName);
+
+ probe.output().out.println("Validity Period: " + authCacheMBean.getValidity());
+ probe.output().out.println("Update Interval: " + authCacheMBean.getUpdateInterval());
+ probe.output().out.println("Max Entries: " + authCacheMBean.getMaxEntries());
+ probe.output().out.println("Active Update: " + authCacheMBean.getActiveUpdate());
+ }
+
+ private AuthCacheMBean getAuthCacheMBean(NodeProbe probe, String cacheName)
Review comment:
We have a copy of this in both GetAuthCacheConfig and SetAuthCacheConfig. Is this intentional?
##########
File path: test/unit/org/apache/cassandra/tools/nodetool/GetAuthCacheConfigTest.java
##########
@@ -0,0 +1,145 @@
+/*
+ * 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.cassandra.tools.nodetool;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import org.apache.cassandra.auth.AuthCache;
+import org.apache.cassandra.auth.AuthenticatedUser;
+import org.apache.cassandra.auth.NetworkPermissionsCacheMBean;
+import org.apache.cassandra.auth.PasswordAuthenticator;
+import org.apache.cassandra.auth.PermissionsCacheMBean;
+import org.apache.cassandra.auth.Roles;
+import org.apache.cassandra.auth.RolesCacheMBean;
+import org.apache.cassandra.auth.jmx.AuthorizationProxy;
+import org.apache.cassandra.config.DatabaseDescriptor;
+import org.apache.cassandra.cql3.CQLTester;
+import org.apache.cassandra.tools.ToolRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class GetAuthCacheConfigTest extends CQLTester
+{
+ @BeforeClass
+ public static void setup() throws Exception
+ {
+ CQLTester.setUpClass();
+ CQLTester.requireAuthentication();
+ startJMXServer();
+ }
+
+ @Test
+ @SuppressWarnings("SingleCharacterStringConcatenation")
+ public void testMaybeChangeDocs()
+ {
+ // If you added, modified options or help, please update docs if necessary
+ ToolRunner.ToolResult tool = ToolRunner.invokeNodetool("help", "getauthcacheconfig");
+ tool.assertOnCleanExit();
+
+ String help = "NAME\n" +
+ " nodetool getauthcacheconfig - Get configuration of Auth cache\n" +
+ "\n" +
+ "SYNOPSIS\n" +
+ " nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)]\n" +
+ " [(-pp | --print-port)] [(-pw <password> | --password <password>)]\n" +
+ " [(-pwf <passwordFilePath> | --password-file <passwordFilePath>)]\n" +
+ " [(-u <username> | --username <username>)] getauthcacheconfig\n" +
+ " --cache-name <cache-name>\n" +
+ "\n" +
+ "OPTIONS\n" +
+ " --cache-name <cache-name>\n" +
+ " Name of Auth cache (required)\n" +
+ "\n" +
+ " -h <host>, --host <host>\n" +
+ " Node hostname or ip address\n" +
+ "\n" +
+ " -p <port>, --port <port>\n" +
+ " Remote jmx agent port number\n" +
+ "\n" +
+ " -pp, --print-port\n" +
+ " Operate in 4.0 mode with hosts disambiguated by port number\n" +
+ "\n" +
+ " -pw <password>, --password <password>\n" +
+ " Remote jmx agent password\n" +
+ "\n" +
+ " -pwf <passwordFilePath>, --password-file <passwordFilePath>\n" +
+ " Path to the JMX password file\n" +
+ "\n" +
+ " -u <username>, --username <username>\n" +
+ " Remote jmx agent username\n" +
+ "\n" +
+ "\n";
+ assertThat(tool.getStdout()).isEqualTo(help);
+ }
+
+ @Test
+ public void testInvalidCacheName()
+ {
+ ToolRunner.ToolResult tool = ToolRunner.invokeNodetool("getauthcacheconfig");
+ assertThat(tool.getExitCode()).isEqualTo(1);
+ assertThat(tool.getStdout())
+ .isEqualTo(wrapByDefaultNodetoolMessage("Required option '--cache-name' is missing"));
+ assertThat(tool.getStderr()).isEmpty();
+
+ tool = ToolRunner.invokeNodetool("getauthcacheconfig", "--cache-name");
+ assertThat(tool.getExitCode()).isEqualTo(1);
+ assertThat(tool.getStdout())
Review comment:
nit: these line breaks make this test less readable. Code style guides have a soft recommendation at 120 char wide (see: https://cassandra.apache.org/_/development/code_style.html), specifically:
> Try to keep lines under 120 characters, but use good judgement. It is better to exceed 120 by a little, than split a line that has no natural splitting points.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org