2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Nordix Foundation.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.models.pap.persistence.provider;
23 import static org.assertj.core.api.Assertions.assertThat;
24 import static org.assertj.core.api.Assertions.assertThatThrownBy;
25 import static org.junit.Assert.assertEquals;
26 import static org.junit.Assert.assertThrows;
27 import static org.junit.Assert.assertTrue;
29 import java.time.Instant;
30 import java.time.temporal.ChronoUnit;
31 import java.util.ArrayList;
32 import java.util.List;
33 import java.util.Properties;
34 import java.util.concurrent.TimeUnit;
35 import org.awaitility.Awaitility;
36 import org.eclipse.persistence.config.PersistenceUnitProperties;
37 import org.junit.After;
38 import org.junit.Before;
39 import org.junit.Test;
40 import org.onap.policy.models.base.PfModelRuntimeException;
41 import org.onap.policy.models.dao.DaoParameters;
42 import org.onap.policy.models.dao.PfDao;
43 import org.onap.policy.models.dao.PfDaoFactory;
44 import org.onap.policy.models.dao.impl.DefaultPfDao;
45 import org.onap.policy.models.pap.concepts.PolicyAudit;
46 import org.onap.policy.models.pap.concepts.PolicyAudit.AuditAction;
47 import org.onap.policy.models.pap.persistence.provider.PolicyAuditProvider.AuditFilter;
48 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
51 * Class for unit testing {@link PolicyAuditProvider}.
53 * @author Adheli Tavares (adheli.tavares@est.tech)
56 public class PolicyAuditProviderTest {
58 private static final String FIELD_IS_NULL = "%s is marked .*ull but is null";
59 private static final String GROUP_A = "groupA";
60 private static final String GROUP_B = "groupB";
61 private static final ToscaConceptIdentifier MY_POLICY = new ToscaConceptIdentifier("MyPolicy", "1.2.3");
62 private static final ToscaConceptIdentifier MY_POLICY2 = new ToscaConceptIdentifier("MyPolicyB", "2.3.4");
63 private static final Integer NUMBER_RECORDS = 10;
68 * Set up the DAO towards the database.
70 * @throws Exception on database errors
73 public void setupDao() throws Exception {
74 final DaoParameters daoParameters = new DaoParameters();
75 daoParameters.setPluginClass(DefaultPfDao.class.getName());
77 daoParameters.setPersistenceUnit("ToscaConceptTest");
79 Properties jdbcProperties = new Properties();
80 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_USER, "policy");
81 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_PASSWORD, "P01icY");
83 if (System.getProperty("USE-MARIADB") != null) {
84 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, "org.mariadb.jdbc.Driver");
85 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, "jdbc:mariadb://localhost:3306/policy");
87 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_DRIVER, "org.h2.Driver");
88 jdbcProperties.setProperty(PersistenceUnitProperties.JDBC_URL, "jdbc:h2:mem:PolicyAuditProviderTest");
91 daoParameters.setJdbcProperties(jdbcProperties);
93 pfDao = new PfDaoFactory().createPfDao(daoParameters);
94 pfDao.init(daoParameters);
98 public void teardown() {
103 public void testCreatePolicyAudit() {
104 PolicyAuditProvider provider = new PolicyAuditProvider();
106 Instant date = Instant.now();
107 provider.createAuditRecords(pfDao, generatePolicyAudits(date, GROUP_A, MY_POLICY));
109 List<PolicyAudit> records =
110 provider.getAuditRecords(pfDao, AuditFilter.builder().recordNum(NUMBER_RECORDS).build());
111 assertThat(records).hasSize(2);
113 // as the start date is 10 min ahead of first record, shouldn't return any records
114 List<PolicyAudit> emptyList = provider.getAuditRecords(pfDao,
115 AuditFilter.builder().fromDate(Instant.now().plusSeconds(600)).recordNum(600).build());
116 assertThat(emptyList).isEmpty();
120 public void testCreatePolicyAuditInvalid() {
121 PolicyAuditProvider provider = new PolicyAuditProvider();
123 List<PolicyAudit> audits = List.of(PolicyAudit.builder().pdpType("pdpType").action(AuditAction.DEPLOYMENT)
124 .timestamp(Instant.now()).build());
126 assertThrows(PfModelRuntimeException.class, () -> provider.createAuditRecords(pfDao, audits));
128 List<PolicyAudit> records =
129 provider.getAuditRecords(pfDao, AuditFilter.builder().recordNum(NUMBER_RECORDS).build());
130 assertThat(records).isEmpty();
134 public void testFilters() {
135 PolicyAuditProvider provider = new PolicyAuditProvider();
137 Instant date = Instant.now().truncatedTo(ChronoUnit.SECONDS);
138 provider.createAuditRecords(pfDao, generatePolicyAudits(date, GROUP_A, MY_POLICY));
139 provider.createAuditRecords(pfDao, generatePolicyAudits(date, GROUP_B, MY_POLICY));
140 provider.createAuditRecords(pfDao, generatePolicyAudits(date, GROUP_B, MY_POLICY2));
141 Awaitility.await().pollDelay(3, TimeUnit.SECONDS).until(() -> {
145 List<PolicyAudit> records = provider.getAuditRecords(pfDao,
146 AuditFilter.builder().fromDate(date).toDate(Instant.now()).recordNum(NUMBER_RECORDS).build());
147 assertThat(records).hasSize(6);
149 List<PolicyAudit> recordsWithGroupB = provider.getAuditRecords(pfDao,
150 AuditFilter.builder().pdpGroup(GROUP_B).recordNum(NUMBER_RECORDS).build());
151 assertThat(recordsWithGroupB).hasSize(4);
153 List<PolicyAudit> recordsWithActionDeploy = provider.getAuditRecords(pfDao,
154 AuditFilter.builder().action(AuditAction.DEPLOYMENT).recordNum(NUMBER_RECORDS).build());
155 assertThat(recordsWithActionDeploy).hasSize(3);
157 List<PolicyAudit> recordsWithMyPolicy = provider.getAuditRecords(pfDao, AuditFilter.builder()
158 .name(MY_POLICY.getName()).version(MY_POLICY.getVersion()).recordNum(NUMBER_RECORDS).build());
159 assertThat(recordsWithMyPolicy).hasSize(4);
163 public void testLoadRecordsForLimit() {
164 PolicyAuditProvider provider = new PolicyAuditProvider();
166 List<PolicyAudit> loadAudits = new ArrayList<>();
168 // going to create 102 records.
169 for (int i = 0; i <= 50; i++) {
170 loadAudits.addAll(generatePolicyAudits(Instant.now().plusSeconds(i), GROUP_A, MY_POLICY));
173 provider.createAuditRecords(pfDao, loadAudits);
175 List<PolicyAudit> records =
176 provider.getAuditRecords(pfDao, AuditFilter.builder().recordNum(NUMBER_RECORDS).build());
177 assertThat(records).hasSize(10);
179 // check that is being ordered
180 assertTrue(records.get(0).getTimestamp().isAfter(records.get(9).getTimestamp()));
181 assertEquals(loadAudits.get(loadAudits.size() - 1).getTimestamp(), records.get(0).getTimestamp());
183 // try to get 102 records should return 100
184 records = provider.getAuditRecords(pfDao, AuditFilter.builder().recordNum(102).build());
185 assertThat(records).hasSize(100);
187 // try to get -1 records should return 100
188 records = provider.getAuditRecords(pfDao, AuditFilter.builder().recordNum(-1).build());
189 assertThat(records).hasSize(100);
193 public void policyProviderExceptions() {
194 PolicyAuditProvider provider = new PolicyAuditProvider();
196 assertThatThrownBy(() -> {
197 provider.createAuditRecords(null, null);
198 }).hasMessageMatching(String.format(FIELD_IS_NULL, "dao"));
200 assertThatThrownBy(() -> {
201 provider.createAuditRecords(pfDao, null);
202 }).hasMessageMatching(String.format(FIELD_IS_NULL, "audits"));
204 assertThatThrownBy(() -> {
205 provider.getAuditRecords(null, AuditFilter.builder().build());
206 }).hasMessageMatching(String.format(FIELD_IS_NULL, "dao"));
208 assertThatThrownBy(() -> {
209 provider.getAuditRecords(pfDao, null);
210 }).hasMessageMatching(String.format(FIELD_IS_NULL, "auditFilter"));
213 private List<PolicyAudit> generatePolicyAudits(Instant date, String group, ToscaConceptIdentifier policy) {
215 PolicyAudit deploy = PolicyAudit.builder()
219 .action(AuditAction.DEPLOYMENT)
220 .timestamp(date.truncatedTo(ChronoUnit.SECONDS))
223 PolicyAudit undeploy = PolicyAudit.builder()
227 .action(AuditAction.UNDEPLOYMENT)
228 .timestamp(date.plusSeconds(1).truncatedTo(ChronoUnit.SECONDS))
232 return List.of(deploy, undeploy);