[
https://issues.apache.org/jira/browse/HADOOP-17511?focusedWorklogId=601082&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-601082
]
ASF GitHub Bot logged work on HADOOP-17511:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 24/May/21 09:32
Start Date: 24/May/21 09:32
Worklog Time Spent: 10m
Work Description: steveloughran commented on a change in pull request
#2807:
URL: https://github.com/apache/hadoop/pull/2807#discussion_r637815424
##########
File path:
hadoop-tools/hadoop-aws/src/test/java/org/apache/hadoop/fs/s3a/audit/AbstractAuditingTest.java
##########
@@ -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.hadoop.fs.s3a.audit;
+
+import java.io.IOException;
+import java.util.Map;
+
+import com.amazonaws.services.s3.model.GetObjectMetadataRequest;
+import org.junit.After;
+import org.junit.Before;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.s3a.Statistic;
+import org.apache.hadoop.fs.s3a.api.RequestFactory;
+import org.apache.hadoop.fs.s3a.impl.RequestFactoryImpl;
+import org.apache.hadoop.fs.statistics.IOStatisticAssertions;
+import org.apache.hadoop.fs.statistics.impl.IOStatisticsStore;
+import org.apache.hadoop.fs.store.audit.AuditSpan;
+import org.apache.hadoop.test.AbstractHadoopTestBase;
+
+import static org.apache.hadoop.fs.s3a.Statistic.INVOCATION_GET_FILE_STATUS;
+import static
org.apache.hadoop.fs.s3a.audit.S3AAuditConstants.UNAUDITED_OPERATION;
+import static
org.apache.hadoop.fs.s3a.audit.AuditTestSupport.createIOStatisticsStoreForAuditing;
+import static org.apache.hadoop.service.ServiceOperations.stopQuietly;
+import static org.apache.hadoop.test.LambdaTestUtils.intercept;
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Abstract class for auditor unit tests.
+ */
+public abstract class AbstractAuditingTest extends AbstractHadoopTestBase {
+
+ protected static final String OPERATION
+ = INVOCATION_GET_FILE_STATUS.getSymbol();
+
+ /**
+ * Logging.
+ */
+ private static final Logger LOG =
+ LoggerFactory.getLogger(AbstractAuditingTest.class);
+
+ public static final String PATH_1 = "/path1";
+
+ public static final String PATH_2 = "/path2";
+
+ /**
+ * Statistics store with the auditor counters wired up.
+ */
+ private final IOStatisticsStore ioStatistics =
+ createIOStatisticsStoreForAuditing();
+
+ private RequestFactory requestFactory;
+
+ private AuditManagerS3A manager;
+
+ @Before
+ public void setup() throws Exception {
+ requestFactory = RequestFactoryImpl.builder()
+ .withBucket("bucket")
+ .build();
+ manager = AuditIntegration.createAndStartAuditManager(
+ createConfig(),
+ ioStatistics);
+ }
+
+ /**
+ * Create config.
+ * @return config to use when creating a manager
+ */
+ protected abstract Configuration createConfig();
+
+ @After
+ public void teardown() {
+ stopQuietly(manager);
+ }
+
+ protected IOStatisticsStore getIOStatistics() {
+ return ioStatistics;
+ }
+
+ protected RequestFactory getRequestFactory() {
+ return requestFactory;
+ }
+
+ protected AuditManagerS3A getManager() {
+ return manager;
+ }
+
+ /**
+ * Assert that a specific span is active.
+ * This matches on the wrapped spans.
+ * @param span span to assert over.
+ */
+ protected void assertActiveSpan(final AuditSpan span) {
+ assertThat(activeSpan())
+ .isSameAs(span);
+ }
+
+ /**
+ * Assert a span is unbound/invalid.
+ * @param span span to assert over.
+ */
+ protected void assertUnbondedSpan(final AuditSpan span) {
+ assertThat(span.isValidSpan())
+ .describedAs("Validity of %s", span)
+ .isFalse();
+ }
+
+ protected AuditSpanS3A activeSpan() {
+ return manager.getActiveAuditSpan();
+ }
+
+ /**
+ * Create a head request and pass it through the manager's beforeExecution()
+ * callback.
+ * @return a processed request.
+ */
+ protected GetObjectMetadataRequest head() {
+ return manager.beforeExecution(
+ requestFactory.newGetObjectMetadataRequest("/"));
+ }
+
+ /**
+ * Assert a head request fails as there is no
+ * active span.
+ */
+ protected void assertHeadUnaudited() throws Exception {
+ intercept(AuditFailureException.class,
+ UNAUDITED_OPERATION, this::head);
+ }
+
+ /**
+ * Assert that the audit failure is of a given value.
+ * Returns the value to assist in chaining,
+ * @param expected expected value
+ * @return the expected value.
+ */
+ protected long verifyAuditFailureCount(
+ final long expected) {
+ return verifyCounter(Statistic.AUDIT_FAILURE, expected);
+ }
+
+ /**
+ * Assert that the audit execution count
+ * is of a given value.
+ * Returns the value to assist in chaining,
+ * @param expected expected value
+ * @return the expected value.
+ */
+ protected long verifyAuditExecutionCount(
+ final long expected) {
+ return verifyCounter(Statistic.AUDIT_REQUEST_EXECUTION, expected);
+ }
+
+ /**
+ * Assert that a statistic counter is of a given value.
+ * Returns the value to assist in chaining,
+ * @param statistic statistic to check
+ * @param expected expected value
+ * @return the expected value.
+ */
+ protected long verifyCounter(final Statistic statistic,
Review comment:
leaving protected in case a subclass wants to use it
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 601082)
Time Spent: 19h 40m (was: 19.5h)
> Add an Audit plugin point for S3A auditing/context
> --------------------------------------------------
>
> Key: HADOOP-17511
> URL: https://issues.apache.org/jira/browse/HADOOP-17511
> Project: Hadoop Common
> Issue Type: Sub-task
> Affects Versions: 3.3.1
> Reporter: Steve Loughran
> Assignee: Steve Loughran
> Priority: Major
> Labels: pull-request-available
> Time Spent: 19h 40m
> Remaining Estimate: 0h
>
> Add a way for auditing tools to correlate S3 object calls with Hadoop FS API
> calls.
> Initially just to log/forward to an auditing service.
> Later: let us attach them as parameters in S3 requests, such as opentrace
> headeers or (my initial idea: http referrer header -where it will get into
> the log)
> Challenges
> * ensuring the audit span is created for every public entry point. That will
> have to include those used in s3guard tools, some defacto public APIs
> * and not re-entered for active spans. s3A code must not call back into the
> FS API points
> * Propagation across worker threads
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
