Skip to content

Add test to make sure exception causes aren't sent to callers #1639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2022
Merged

Add test to make sure exception causes aren't sent to callers #1639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion src/test/java/org/opensearch/security/filter/SecurityFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package org.opensearch.security.filter;

import org.opensearch.OpenSearchSecurityException;
import org.opensearch.security.auditlog.AuditLog;
import org.opensearch.security.auth.BackendRegistry;
import org.opensearch.security.configuration.AdminDNs;
Expand All @@ -26,20 +27,27 @@
import org.opensearch.security.support.WildcardMatcher;
import com.google.common.collect.ImmutableSet;

import org.junit.Assert;
import org.opensearch.action.ActionListener;
import org.opensearch.action.ActionResponse;
import org.opensearch.client.Client;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.settings.Settings;
import org.opensearch.threadpool.ThreadPool;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.mockito.ArgumentCaptor;

import java.util.Arrays;
import java.util.Collection;

import static org.junit.Assert.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;

@RunWith(Parameterized.class)
public class SecurityFilterTest {
Expand Down Expand Up @@ -84,4 +92,41 @@ public void testImmutableIndicesWildcardMatcher() {
);
assertEquals(expected, filter.getImmutableIndicesMatcher());
}

@SuppressWarnings("unchecked")
@Test
public void testUnexepectedCausesAreNotSendToCallers() {
// Setup
final AuditLog auditLog = mock(AuditLog.class);
when(auditLog.getComplianceConfig()).thenThrow(new RuntimeException("ABC!"));
final ActionListener<ActionResponse> listener = mock(ActionListener.class);

final SecurityFilter filter = new SecurityFilter(
mock(Client.class),
settings,
mock(PrivilegesEvaluator.class),
mock(AdminDNs.class),
mock(DlsFlsRequestValve.class),
auditLog,
new ThreadPool(Settings.builder().put("node.name", "mock").build()),
mock(ClusterService.class),
mock(CompatConfig.class),
mock(IndexResolverReplacer.class),
mock(BackendRegistry.class)
);

// Act
filter.apply(null, null, null, listener, null);

// Verify
verify(auditLog).getComplianceConfig(); // Make sure the exception was thrown

final ArgumentCaptor<OpenSearchSecurityException> cap = ArgumentCaptor.forClass(OpenSearchSecurityException.class);
verify(listener).onFailure(cap.capture());

assertNull(cap.getValue().getCause(), "The cause should never be included as it will leak to callers");
assertFalse(cap.getValue().getMessage().contains("ABC!"), "Make sure the cause exception wasn't toStringed in the method");

verifyNoMoreInteractions(auditLog, listener);
}
}