summaryrefslogtreecommitdiffstats
path: root/main/src/test
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2021-07-21 18:24:57 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2021-07-22 15:48:15 -0400
commit96de2b981fb063408a021ca6b3e01783077b651f (patch)
treeb02f864f1701a38bf7426960b7148394e912d74c /main/src/test
parentf41573715bb94c6d7adf809d6f489f8b04948baa (diff)
Add apis for policy audit
Adding api's to fetch policy audit records from db. This is as per the design documented here - https://wiki.onap.org/display/DW/PAP+REST+API+changes+for+Istanbul+release Issue-ID: POLICY-3340 Change-Id: Iff80ab695d17ec38d4fe8ab98c0b95048cbae448 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'main/src/test')
-rw-r--r--main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditControllerV1.java70
-rw-r--r--main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditProvider.java104
-rw-r--r--main/src/test/java/org/onap/policy/pap/main/rest/e2e/PolicyAuditTest.java145
3 files changed, 319 insertions, 0 deletions
diff --git a/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditControllerV1.java b/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditControllerV1.java
new file mode 100644
index 00000000..56833520
--- /dev/null
+++ b/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditControllerV1.java
@@ -0,0 +1,70 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Bell Canada. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pap.main.rest;
+
+import static org.junit.Assert.assertEquals;
+
+import javax.ws.rs.client.Invocation;
+import javax.ws.rs.core.Response;
+import org.junit.Test;
+
+/**
+ * Note: this tests failure cases; success cases are tested by tests in the "e2e" package.
+ */
+public class TestPolicyAuditControllerV1 extends CommonPapRestServer {
+
+ private static final String POLICY_AUDIT_ENDPOINT = "policies/audit";
+
+ @Test
+ public void testSwagger() throws Exception {
+
+ super.testSwagger(POLICY_AUDIT_ENDPOINT);
+ super.testSwagger(POLICY_AUDIT_ENDPOINT + "/{pdpGroupName}");
+ super.testSwagger(POLICY_AUDIT_ENDPOINT + "/{pdpGroupName}/{policyName}/{policyVersion}");
+ super.testSwagger(POLICY_AUDIT_ENDPOINT + "/{policyName}/{policyVersion}");
+ }
+
+ @Test
+ public void testGetAllAuditRecords() throws Exception {
+ String uri = POLICY_AUDIT_ENDPOINT;
+
+ // verify it fails when no authorization info is included
+ checkUnauthRequest(uri, req -> req.get());
+ }
+
+ @Test
+ public void testGetAuditRecordsByGroup() throws Exception {
+ checkRequest(POLICY_AUDIT_ENDPOINT + "/my-group-name");
+ }
+
+ @Test
+ public void testGetAuditRecordsOfPolicy() throws Exception {
+ checkRequest(POLICY_AUDIT_ENDPOINT + "/my-group-name/my-name/1.2.3");
+ checkRequest(POLICY_AUDIT_ENDPOINT + "/my-name/1.2.3");
+ }
+
+ private void checkRequest(String uri) throws Exception {
+ Invocation.Builder invocationBuilder = sendRequest(uri);
+ Response rawresp = invocationBuilder.get();
+ assertEquals(Response.Status.NOT_FOUND.getStatusCode(), rawresp.getStatus());
+
+ // verify it fails when no authorization info is included
+ checkUnauthRequest(uri, req -> req.get());
+ }
+}
diff --git a/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditProvider.java b/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditProvider.java
new file mode 100644
index 00000000..7d42912f
--- /dev/null
+++ b/main/src/test/java/org/onap/policy/pap/main/rest/TestPolicyAuditProvider.java
@@ -0,0 +1,104 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Bell Canada. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pap.main.rest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.when;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.common.utils.services.Registry;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.pap.concepts.PolicyAudit;
+import org.onap.policy.models.pap.concepts.PolicyAudit.AuditAction;
+import org.onap.policy.models.pap.persistence.provider.PolicyAuditProvider.AuditFilter;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
+
+public class TestPolicyAuditProvider extends ProviderSuper {
+ private static final String TEST_GROUP = "testGroup";
+ private static final String TEST_PDP_TYPE = "testPdpType";
+ private static final ToscaConceptIdentifier POLICY_A = new ToscaConceptIdentifier("PolicyA", "1.0.0");
+ private static final ToscaConceptIdentifier POLICY_B = new ToscaConceptIdentifier("PolicyB", "2.0.0");
+
+ private PolicyAuditProvider provider;
+
+ @AfterClass
+ public static void tearDownAfterClass() {
+ Registry.newRegistry();
+ }
+
+ @Override
+ @Before
+ public void setUp() throws Exception {
+
+ super.setUp();
+ provider = new PolicyAuditProvider();
+ }
+
+ @Test
+ public void testGetAuditRecords() throws PfModelException {
+
+ AuditFilter auditFilter = AuditFilter.builder().recordNum(5).fromDate(null).toDate(null).build();
+
+ buildAuditRecords(auditFilter);
+
+ List<PolicyAudit> result = new ArrayList<>(provider.getAuditRecords(auditFilter));
+ validateAuditRecords(result, 2);
+ }
+
+ private void buildAuditRecords(AuditFilter auditFilter) {
+ PolicyAudit audit1 = PolicyAudit.builder().auditId(123L).pdpGroup(TEST_GROUP).pdpType(TEST_PDP_TYPE)
+ .policy(POLICY_A).action(AuditAction.DEPLOYMENT).timestamp(Instant.now()).user(DEFAULT_USER)
+ .build();
+
+ PolicyAudit audit2 = PolicyAudit.builder().auditId(456L).pdpGroup(TEST_GROUP).pdpType(TEST_PDP_TYPE)
+ .policy(POLICY_B).action(AuditAction.UNDEPLOYMENT).timestamp(Instant.now()).user(DEFAULT_USER)
+ .build();
+
+ if (auditFilter.getName() == null) {
+ when(dao.getAuditRecords(auditFilter)).thenReturn(List.of(audit1, audit2));
+ } else {
+ when(dao.getAuditRecords(auditFilter)).thenReturn(List.of(audit1));
+ }
+
+ }
+
+ private void validateAuditRecords(List<PolicyAudit> result, int count) {
+ assertThat(result).hasSize(count);
+ for (PolicyAudit audit : result) {
+ if (audit.getAuditId() == 123L) {
+ assertThat(audit.getPdpGroup()).isEqualTo(TEST_GROUP);
+ assertThat(audit.getPdpType()).isEqualTo(TEST_PDP_TYPE);
+ assertThat(audit.getPolicy()).isEqualTo(POLICY_A);
+ assertThat(audit.getAction()).isEqualTo(AuditAction.DEPLOYMENT);
+ assertThat(audit.getUser()).isEqualTo(DEFAULT_USER);
+ } else if (audit.getAuditId() == 456L) {
+ assertThat(audit.getPdpGroup()).isEqualTo(TEST_GROUP);
+ assertThat(audit.getPdpType()).isEqualTo(TEST_PDP_TYPE);
+ assertThat(audit.getPolicy()).isEqualTo(POLICY_B);
+ assertThat(audit.getAction()).isEqualTo(AuditAction.UNDEPLOYMENT);
+ assertThat(audit.getUser()).isEqualTo(DEFAULT_USER);
+ }
+ }
+ }
+}
diff --git a/main/src/test/java/org/onap/policy/pap/main/rest/e2e/PolicyAuditTest.java b/main/src/test/java/org/onap/policy/pap/main/rest/e2e/PolicyAuditTest.java
new file mode 100644
index 00000000..c4de1f4a
--- /dev/null
+++ b/main/src/test/java/org/onap/policy/pap/main/rest/e2e/PolicyAuditTest.java
@@ -0,0 +1,145 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Bell Canada. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.pap.main.rest.e2e;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.Assert.assertEquals;
+
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+import javax.ws.rs.client.Invocation;
+import javax.ws.rs.core.GenericType;
+import javax.ws.rs.core.Response;
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.common.utils.services.Registry;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.base.PfModelRuntimeException;
+import org.onap.policy.models.pap.concepts.PolicyAudit;
+import org.onap.policy.models.pap.concepts.PolicyAudit.AuditAction;
+import org.onap.policy.models.provider.PolicyModelsProvider;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
+import org.onap.policy.pap.main.PapConstants;
+import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
+
+public class PolicyAuditTest extends End2EndBase {
+ private static final String TEST_GROUP = "testGroup";
+ private static final String TEST_PDP_TYPE = "testPdpType";
+ private static final ToscaConceptIdentifier POLICY_A = new ToscaConceptIdentifier("PolicyA", "1.0.0");
+ private static final ToscaConceptIdentifier POLICY_B = new ToscaConceptIdentifier("PolicyB", "2.0.0");
+ private static final String DEFAULT_USER = "TEST";
+ private static final String POLICY_AUDIT_ENDPOINT = "policies/audit";
+ private static final String URI_SEPERATOR = "/";
+
+ @Override
+ @Before
+ public void setUp() throws Exception {
+ super.setUp();
+ setupEnv();
+ }
+
+ private void setupEnv() {
+ List<PolicyAudit> recordList = new ArrayList<>();
+ PolicyModelsProviderFactoryWrapper modelProviderWrapper =
+ Registry.get(PapConstants.REG_PAP_DAO_FACTORY, PolicyModelsProviderFactoryWrapper.class);
+
+ try (PolicyModelsProvider databaseProvider = modelProviderWrapper.create()) {
+ PolicyAudit audit1 = PolicyAudit.builder().auditId(123L).pdpGroup(TEST_GROUP).pdpType(TEST_PDP_TYPE)
+ .policy(POLICY_A).action(AuditAction.DEPLOYMENT).timestamp(Instant.now()).user(DEFAULT_USER)
+ .build();
+ PolicyAudit audit2 = PolicyAudit.builder().auditId(456L).pdpGroup(TEST_GROUP).pdpType(TEST_PDP_TYPE)
+ .policy(POLICY_B).action(AuditAction.UNDEPLOYMENT).timestamp(Instant.now())
+ .user(DEFAULT_USER).build();
+ recordList.add(audit1);
+ recordList.add(audit2);
+ databaseProvider.createAuditRecords(recordList);
+ } catch (final PfModelException exp) {
+ throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, exp.getMessage());
+ }
+ }
+
+ @Test
+ public void testGetAllAuditRecords() throws Exception {
+ String uri = POLICY_AUDIT_ENDPOINT;
+
+ Invocation.Builder invocationBuilder = sendRequest(uri);
+ Response rawresp = invocationBuilder.get();
+ assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+
+ List<PolicyAudit> resp = rawresp.readEntity(new GenericType<List<PolicyAudit>>() {});
+ validateAuditRecords(resp, 2);
+ }
+
+ @Test
+ public void testGetAuditRecordsByGroup() throws Exception {
+ String uri = POLICY_AUDIT_ENDPOINT + URI_SEPERATOR + TEST_GROUP;
+
+ Invocation.Builder invocationBuilder = sendRequest(uri);
+ Response rawresp = invocationBuilder.get();
+ assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+
+ List<PolicyAudit> resp = rawresp.readEntity(new GenericType<List<PolicyAudit>>() {});
+ validateAuditRecords(resp, 2);
+ }
+
+ @Test
+ public void testGetAuditRecordsOfPolicyWithGroup() throws Exception {
+ String uri = POLICY_AUDIT_ENDPOINT + URI_SEPERATOR + TEST_GROUP + URI_SEPERATOR + POLICY_A.getName()
+ + URI_SEPERATOR + POLICY_A.getVersion();
+
+ Invocation.Builder invocationBuilder = sendRequest(uri);
+ Response rawresp = invocationBuilder.get();
+ assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+
+ List<PolicyAudit> resp = rawresp.readEntity(new GenericType<List<PolicyAudit>>() {});
+ validateAuditRecords(resp, 1);
+ }
+
+ @Test
+ public void testGetAuditRecordsOfPolicyWithoutGroup() throws Exception {
+ String uri = POLICY_AUDIT_ENDPOINT + URI_SEPERATOR + POLICY_A.getName() + URI_SEPERATOR + POLICY_A.getVersion();
+
+ Invocation.Builder invocationBuilder = sendRequest(uri);
+ Response rawresp = invocationBuilder.get();
+ assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus());
+
+ List<PolicyAudit> resp = rawresp.readEntity(new GenericType<List<PolicyAudit>>() {});
+ validateAuditRecords(resp, 1);
+ }
+
+ private void validateAuditRecords(List<PolicyAudit> result, int count) {
+ assertThat(result).hasSize(count);
+ for (PolicyAudit audit : result) {
+ if (audit.getAuditId() == 123L) {
+ assertThat(audit.getPdpGroup()).isEqualTo(TEST_GROUP);
+ assertThat(audit.getPdpType()).isEqualTo(TEST_PDP_TYPE);
+ assertThat(audit.getPolicy()).isEqualTo(POLICY_A);
+ assertThat(audit.getAction()).isEqualTo(AuditAction.DEPLOYMENT);
+ assertThat(audit.getUser()).isEqualTo(DEFAULT_USER);
+ } else if (audit.getAuditId() == 456L) {
+ assertThat(audit.getPdpGroup()).isEqualTo(TEST_GROUP);
+ assertThat(audit.getPdpType()).isEqualTo(TEST_PDP_TYPE);
+ assertThat(audit.getPolicy()).isEqualTo(POLICY_B);
+ assertThat(audit.getAction()).isEqualTo(AuditAction.UNDEPLOYMENT);
+ assertThat(audit.getUser()).isEqualTo(DEFAULT_USER);
+ }
+ }
+ }
+}