Package org.apache.hadoop.hbase.http.log

Class TestLogLevel

java.lang.Object

org.apache.hadoop.hbase.http.log.TestLogLevel

@Tag("org.apache.hadoop.hbase.testclassification.MiscTests") @Tag("org.apache.hadoop.hbase.testclassification.SmallTests")
public class TestLogLevel
extends Object

Test LogLevel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	TestLogLevel.Protocol
private static interface	TestLogLevel.ThrowingConsumer
private static interface	TestLogLevel.ThrowingRunnable

Field Summary

Fields

Modifier and Type	Field	Description
private static org.apache.hadoop.conf.Configuration	clientConf
private static final String	clientPrincipal
private static final Pattern	EFFECTIVE_LEVEL
private static String	HTTP_PRINCIPAL
private static HBaseCommonTestingUtil	HTU
private static org.apache.hadoop.minikdc.MiniKdc	kdc
private static String	keystoresDir
private static final String	KEYTAB
private static File	keyTabFile
private static final String	LOCALHOST
private static final org.apache.logging.log4j.Logger	log
private static final String	logName
private static final String	PRINCIPAL
private static final String	protectedLogName
private static final String	protectedPrefix
private static org.apache.hadoop.conf.Configuration	serverConf
private static org.apache.hadoop.conf.Configuration	sslConf
private static String	sslConfDir

Constructor Summary

Constructors

Constructor	Description
TestLogLevel()

Method Summary

Modifier and Type	Method	Description
private org.apache.hadoop.hbase.http.HttpServer	createServer(String protocol, boolean isSpnego)	Creates and starts a Jetty server binding at an ephemeral port to run LogLevel servlet.
private static void	exceptionShouldContains(String substr, Throwable throwable)	Assert that a throwable or one of its causes should contain the substr in its message.
private String	extractEffectiveLevel(String response)	Extract effective log level from server response.
private String	getLevel(String protocol, String authority, String logName)	Run LogLevel command line to start a client to get log level of this test class.
private static org.apache.hadoop.conf.Configuration	getSslConfig(org.apache.hadoop.conf.Configuration conf)	Get the SSL configuration.
(package private) static boolean	isBindException(Throwable t)	The Kerby-backed MiniKdc wraps a failure to bind the KDC port in a org.apache.kerby...KrbException rather than surfacing a BindException directly, so we inspect the whole cause chain plus the message to recognise a port conflict.
private void	setLevel(String protocol, String authority, String logName, String newLevel)	Run LogLevel command line to start a client to set log level of this test class to debug.
static void	setUp()
private static org.apache.hadoop.minikdc.MiniKdc	setupMiniKdc()	Sets up MiniKdc for testing security.
private static void	setupSSL(File base)
static void	tearDown()
void	testCommandOptions()	Test client command line options.
void	testGetDebugLogLevel()
void	testGetInfoLogLevel()
private void	testGetLogLevel(TestLogLevel.Protocol protocol, boolean isSpnego, String loggerName, String expectedLevel)
void	testGetLogLevelAllowedInReadonlyMode()	Test getting log level in readonly mode.
void	testIsBindExceptionRecognizesKerbyWrappedBindFailure()	Deterministic regression test for the retry predicate.
void	testLogLevelByHttp()	Server runs HTTP, no SPNEGO.
void	testLogLevelByHttps()	Server runs HTTPS, no SPNEGO.
void	testLogLevelByHttpsWithSpnego()	Server runs HTTPS + SPNEGO.
void	testLogLevelByHttpWithSpnego()	Server runs HTTP + SPNEGO.
void	testSetErrorLogLevel()	Test setting log level to "Error".
void	testSetInfoLogLevel()	Test setting log level to "Info".
private void	testSetLogLevel(TestLogLevel.Protocol protocol, boolean isSpnego, String loggerName, String newLevel)
void	testSetLogLevelDisallowedInReadonlyMode()	Test setting log level in readonly mode.
void	testSettingProtectedLogLevel()
private boolean	validateCommand(String[] args)	Check to see if a command can be accepted.
private void	withLogLevelServer(TestLogLevel.Protocol protocol, boolean isSpnego, TestLogLevel.ThrowingConsumer consumer)	Starts a LogLevel server and executes a client action against it.
private void	withMasterUIReadonly(TestLogLevel.ThrowingRunnable runnable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

keystoresDir

private static String keystoresDir

sslConfDir

private static String sslConfDir

serverConf

private static org.apache.hadoop.conf.Configuration serverConf

clientConf

private static org.apache.hadoop.conf.Configuration clientConf

sslConf

private static org.apache.hadoop.conf.Configuration sslConf

logName

private static final String logName

protectedPrefix

private static final String protectedPrefix

See Also:

• Constant Field Values

protectedLogName

private static final String protectedLogName

log

private static final org.apache.logging.log4j.Logger log

PRINCIPAL

private static final String PRINCIPAL

See Also:

• Constant Field Values

KEYTAB

private static final String KEYTAB

See Also:

• Constant Field Values

kdc

private static org.apache.hadoop.minikdc.MiniKdc kdc

LOCALHOST

private static final String LOCALHOST

See Also:

• Constant Field Values

clientPrincipal

private static final String clientPrincipal

See Also:

• Constant Field Values

HTTP_PRINCIPAL

private static String HTTP_PRINCIPAL

HTU

private static HBaseCommonTestingUtil HTU

keyTabFile

private static File keyTabFile

EFFECTIVE_LEVEL

private static final Pattern EFFECTIVE_LEVEL

Constructor Details

TestLogLevel

public TestLogLevel()

Method Details

setUp

@BeforeAll
public static void setUp()
                  throws Exception

Throws:

Exception

setupMiniKdc

private static org.apache.hadoop.minikdc.MiniKdc setupMiniKdc()
                                                       throws Exception

Sets up MiniKdc for testing security. Copied from HBaseTestingUtility#setupMiniKdc().

Throws:

Exception

isBindException

static boolean isBindException(Throwable t)

The Kerby-backed MiniKdc wraps a failure to bind the KDC port in a org.apache.kerby...KrbException rather than surfacing a BindException directly, so we inspect the whole cause chain plus the message to recognise a port conflict. Both checks are load-bearing across Kerby versions: kerby 1.x preserves the original BindException as the cause (caught by the cause-chain check) while kerby 2.x drops the cause and only appends the bind message (caught by the message check). The message match is lower-cased since the wording is JDK/OS specific.

testIsBindExceptionRecognizesKerbyWrappedBindFailure

@Test
public void testIsBindExceptionRecognizesKerbyWrappedBindFailure()

Deterministic regression test for the retry predicate. A port conflict raised by the Kerby-backed MiniKdc must be recognised as a bind failure whether the BindException is preserved in the cause chain or only reflected in the message; unrelated failures must not be. We model the Kerby wrapper with a plain Exception rather than constructing a real Kerby exception, so the test does not import kerby types (see HBASE-29117).

setupSSL

private static void setupSSL(File base)
                      throws Exception

Throws:

Exception

getSslConfig

private static org.apache.hadoop.conf.Configuration getSslConfig(org.apache.hadoop.conf.Configuration conf)

Get the SSL configuration. This method is copied from KeyStoreTestUtil#getSslConfig() in Hadoop.

Parameters:

conf - to pull client/server SSL settings filename from

Returns:

Configuration instance with ssl configs loaded.

tearDown

@AfterAll
public static void tearDown()

testCommandOptions

@Test
public void testCommandOptions()
                        throws Exception

Test client command line options. Does not validate server behavior.

Throws:

Exception - if commands return unexpected results.

validateCommand

private boolean validateCommand(String[] args)

Check to see if a command can be accepted.

Parameters:

args - a String array of arguments

Returns:

true if the command can be accepted, false if not.

createServer

private org.apache.hadoop.hbase.http.HttpServer createServer(String protocol,
 boolean isSpnego)
                                                      throws Exception

Creates and starts a Jetty server binding at an ephemeral port to run LogLevel servlet.

Parameters:

protocol - "http" or "https"

isSpnego - true if SPNEGO is enabled

Returns:

a created HttpServer object

Throws:

Exception - if unable to create or start a Jetty server

testGetLogLevel

private void testGetLogLevel(TestLogLevel.Protocol protocol,
 boolean isSpnego,
 String loggerName,
 String expectedLevel)
                      throws Exception

Throws:

Exception

testSetLogLevel

private void testSetLogLevel(TestLogLevel.Protocol protocol,
 boolean isSpnego,
 String loggerName,
 String newLevel)
                      throws Exception

Throws:

Exception

withLogLevelServer

private void withLogLevelServer(TestLogLevel.Protocol protocol,
 boolean isSpnego,
 TestLogLevel.ThrowingConsumer consumer)
                         throws Exception

Starts a LogLevel server and executes a client action against it.

Parameters:

protocol - protocol configuration for client and server

isSpnego - whether SPNEGO authentication is enabled

consumer - client action executed with the server authority (host:port)

Throws:

Exception - if server setup or client execution fails

getLevel

private String getLevel(String protocol,
 String authority,
 String logName)
                 throws Exception

Run LogLevel command line to start a client to get log level of this test class.

Parameters:

protocol - specify either http or https

authority - daemon's web UI address

Throws:

Exception - if unable to connect

setLevel

private void setLevel(String protocol,
 String authority,
 String logName,
 String newLevel)
               throws Exception

Run LogLevel command line to start a client to set log level of this test class to debug.

Parameters:

protocol - specify either http or https

authority - daemon's web UI address

Throws:

Exception - if unable to run or log level does not change as expected

extractEffectiveLevel

private String extractEffectiveLevel(String response)

Extract effective log level from server response.

Parameters:

response - server body response string

Returns:

the effective log level

testSettingProtectedLogLevel

@Test
public void testSettingProtectedLogLevel()
                                  throws Exception

Throws:

Exception

testGetDebugLogLevel

@Test
public void testGetDebugLogLevel()
                          throws Exception

Throws:

Exception

testGetInfoLogLevel

@Test
public void testGetInfoLogLevel()
                         throws Exception

Throws:

Exception

testSetInfoLogLevel

@Test
public void testSetInfoLogLevel()
                         throws Exception

Test setting log level to "Info".

Throws:

Exception - if client can't set log level to INFO.

testSetErrorLogLevel

@Test
public void testSetErrorLogLevel()
                          throws Exception

Test setting log level to "Error".

Throws:

Exception - if client can't set log level to ERROR.

testLogLevelByHttp

@Test
public void testLogLevelByHttp()
                        throws Exception

Server runs HTTP, no SPNEGO.

Throws:

Exception - if http client can't access http server, or http client can access https server.

testLogLevelByHttpWithSpnego

@Test
public void testLogLevelByHttpWithSpnego()
                                  throws Exception

Server runs HTTP + SPNEGO.

Throws:

Exception - if http client can't access http server, or http client can access https server.

testLogLevelByHttps

@Test
public void testLogLevelByHttps()
                         throws Exception

Server runs HTTPS, no SPNEGO.

Throws:

Exception - if https client can't access https server, or https client can access http server.

testLogLevelByHttpsWithSpnego

@Test
public void testLogLevelByHttpsWithSpnego()
                                   throws Exception

Server runs HTTPS + SPNEGO.

Throws:

Exception - if https client can't access https server, or https client can access http server.

testGetLogLevelAllowedInReadonlyMode

@Test
public void testGetLogLevelAllowedInReadonlyMode()
                                          throws Exception

Test getting log level in readonly mode.

Throws:

Exception - if a client can't get log level.

testSetLogLevelDisallowedInReadonlyMode

@Test
public void testSetLogLevelDisallowedInReadonlyMode()
                                             throws Exception

Test setting log level in readonly mode.

Throws:

Exception - if a client can set log level.

withMasterUIReadonly

private void withMasterUIReadonly(TestLogLevel.ThrowingRunnable runnable)
                           throws Exception

Throws:

Exception

exceptionShouldContains

private static void exceptionShouldContains(String substr,
 Throwable throwable)

Assert that a throwable or one of its causes should contain the substr in its message. Ideally we should use GenericTestUtils.assertExceptionContains(String, Throwable) util method which asserts t.toString() contains the substr. As the original throwable may have been wrapped in Hadoop3 because of HADOOP-12897, it's required to check all the wrapped causes. After stop supporting Hadoop2, this method can be removed and assertion in tests can use t.getCause() directly, similar to HADOOP-15280.