From e70e2318753cf6217fd809c4b9c9e4e8ce5d0da3 Mon Sep 17 00:00:00 2001 From: vempo Date: Mon, 5 Mar 2018 20:55:58 +0200 Subject: Changes to the audit logging implementation Changes to the API and implementation, fixed issues, added javadoc and unit tests, changed scope of some dependencies to "provided" to prevent transitive when not needed. Change-Id: Ib76ae2f921846c2115fcc5cc61b93625307a7c65 Issue-ID: SDC-772 Signed-off-by: vempo --- .../openecomp/sdc/logging/api/AuditDataTest.java | 59 ++++++++++++++++++++ .../sdc/logging/api/LoggerFactoryTest.java | 2 +- .../openecomp/sdc/logging/api/SpyAuditData.java | 63 ---------------------- 3 files changed, 60 insertions(+), 64 deletions(-) create mode 100644 openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/AuditDataTest.java delete mode 100644 openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/SpyAuditData.java (limited to 'openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org') diff --git a/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/AuditDataTest.java b/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/AuditDataTest.java new file mode 100644 index 0000000000..08ce5089b7 --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/AuditDataTest.java @@ -0,0 +1,59 @@ +/* + * Copyright © 2016-2018 European Support Limited + * + * Licensed 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.openecomp.sdc.logging.api; + +import static org.testng.Assert.*; + +import org.testng.annotations.Test; + +/** + * @author EVITALIY + * @since 04 Mar 18 + */ +public class AuditDataTest { + + @Test + public void allPropertiesReadWhenPopulated() { + + final long start = System.currentTimeMillis(); + final long end = start + 100; + final String responseCode = "Response-Code"; + final String responseDescription = "Response-Description"; + final String ipAddress = "10.56.20.70"; + + AuditData data = AuditData.builder().startTime(start).endTime(end).statusCode(StatusCode.COMPLETE) + .responseCode(responseCode).responseDescription(responseDescription).clientIpAddress(ipAddress).build(); + + assertEquals(data.getClientIpAddress(), ipAddress); + assertEquals(data.getEndTime(), end); + assertEquals(data.getStartTime(), start); + assertEquals(data.getResponseCode(), responseCode); + assertEquals(data.getResponseDescription(), responseDescription); + assertEquals(data.getStatusCode(), StatusCode.COMPLETE); + } + + @Test + public void allPropertiesEmptyWhenUnpopulated() { + AuditData data = AuditData.builder().build(); + assertEquals(data.getStartTime(), 0); + assertEquals(data.getEndTime(), 0); + assertNull(data.getClientIpAddress()); + assertNull(data.getResponseCode()); + assertNull(data.getResponseDescription()); + assertNull(data.getStatusCode()); + } +} \ No newline at end of file diff --git a/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/LoggerFactoryTest.java b/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/LoggerFactoryTest.java index e174a32271..1889f3e172 100644 --- a/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/LoggerFactoryTest.java +++ b/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/LoggerFactoryTest.java @@ -70,7 +70,7 @@ public class LoggerFactoryTest { logger.warn(""); logger.info(""); logger.debug(""); - logger.audit(new SpyAuditData()); + logger.audit(null); logger.metrics(""); } } diff --git a/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/SpyAuditData.java b/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/SpyAuditData.java deleted file mode 100644 index 8766f2598b..0000000000 --- a/openecomp-be/lib/openecomp-sdc-logging-lib/openecomp-sdc-logging-api/src/test/java/org/openecomp/sdc/logging/api/SpyAuditData.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright © 2016-2018 European Support Limited - * - * Licensed 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.openecomp.sdc.logging.api; - -import java.util.HashSet; -import java.util.Set; - -public class SpyAuditData implements AuditData{ - private final Set calledMethods = new HashSet<>(); - - @Override - public long getStartTime() { - calledMethods.add("getStartTime"); - return 0; - } - - @Override - public long getEndTime() { - calledMethods.add("getEndTime"); - return 0; - } - - @Override - public AuditData.StatusCode getStatusCode() { - calledMethods.add("getEndTime"); - return null; - } - - @Override - public String getResponseCode() { - calledMethods.add("getResponseCode"); - return null; - } - - @Override - public String getResponseDescription() { - calledMethods.add("getResponseDescription"); - return null; - } - - @Override - public String getClientIpAddress() { - calledMethods.add("getClientIpAddress"); - return null; - } - - public boolean wasCalled(String method) { - return calledMethods.contains(method); - } -} -- cgit 1.2.3-korg