catalog-be/src/test/java/org/openecomp/sdc/be/auditing/impl/usersadmin/AuditUserEventFuncTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  * Modifications copyright (c) 2019 Nokia
  20  * ================================================================================
  21  */
  22 package org.openecomp.sdc.be.auditing.impl.usersadmin;
  23
  24 import org.junit.Before;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.Captor;
  29 import org.mockito.Mock;
  30 import org.mockito.junit.MockitoJUnitRunner;
  31 import org.openecomp.sdc.be.auditing.api.AuditEventFactory;
  32 import org.openecomp.sdc.be.auditing.impl.AuditAuthRequestEventFactory;
  33 import org.openecomp.sdc.be.auditing.impl.AuditingManager;
  34 import org.openecomp.sdc.be.dao.cassandra.AuditCassandraDao;
  35 import org.openecomp.sdc.be.dao.cassandra.CassandraOperationStatus;
  36 import org.openecomp.sdc.be.model.User;
  37 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  38 import org.openecomp.sdc.be.resources.data.auditing.AuditingGenericEvent;
  39 import org.openecomp.sdc.be.resources.data.auditing.AuthEvent;
  40 import org.openecomp.sdc.be.resources.data.auditing.GetUsersListEvent;
  41 import org.openecomp.sdc.be.resources.data.auditing.UserAccessEvent;
  42 import org.openecomp.sdc.be.resources.data.auditing.UserAdminEvent;
  43 import org.openecomp.sdc.be.resources.data.auditing.model.CommonAuditData;
  44 import org.openecomp.sdc.test.utils.TestConfigurationProvider;
  45
  46 import static org.assertj.core.api.Assertions.assertThat;
  47 import static org.mockito.ArgumentMatchers.any;
  48 import static org.mockito.Mockito.verify;
  49 import static org.mockito.Mockito.when;
  50 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.AUTH_STATUS;
  51 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.AUTH_URL;
  52 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.DESCRIPTION;
  53 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.DESIGNER_USER_ROLE;
  54 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_ADD_USER_LOG_STR;
  55 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_AUTH_REQUEST_LOG_STR;
  56 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_DELETE_USER_LOG_STR;
  57 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_GET_USER_LIST_LOG_STR;
  58 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_UPDATE_USER_LOG_STR;
  59 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.EXPECTED_USER_ACCESS_LOG_STR;
  60 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.MODIFIER_UID;
  61 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.REALM;
  62 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.REQUEST_ID;
  63 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.STATUS_CREATED;
  64 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.STATUS_OK;
  65 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.TESTER_USER_ROLE;
  66 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.UPDATED_USER_EXTENDED_NAME;
  67 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.USER_DETAILS;
  68 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.USER_EMAIL;
  69 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.USER_EXTENDED_NAME;
  70 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.USER_ID;
  71 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.USER_UID;
  72 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.init;
  73 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.modifier;
  74 import static org.openecomp.sdc.be.auditing.impl.AuditTestUtils.user;
  75
  76
  77 @RunWith(MockitoJUnitRunner.class)
  78 public class AuditUserEventFuncTest {
  79     @Mock
  80     private static AuditCassandraDao cassandraDao;
  81     @Captor
  82     private ArgumentCaptor<AuditingGenericEvent> eventCaptor;
  83
  84     private AuditingManager auditingManager;
  85
  86     @Before
  87     public void setUp() {
  88         init();
  89         auditingManager = new AuditingManager(cassandraDao, new TestConfigurationProvider());
  90     }
  91
  92     @Test
  93     public void testUserAccessEvent() {
  94         AuditEventFactory factory = new AuditUserAccessEventFactory(
  95                 CommonAuditData.newBuilder()
  96                         .description(DESCRIPTION)
  97                         .status(STATUS_OK)
  98                         .requestId(REQUEST_ID)
  99                         .build(),
 100                 user);
 101         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 102
 103         assertThat(auditingManager.auditEvent(factory)).isEqualTo(EXPECTED_USER_ACCESS_LOG_STR);
 104         verifyUserAccessEvent();
 105     }
 106
 107     @Test
 108     public void testUserAdminEventForAddUser() {
 109
 110         user.setRole(DESIGNER_USER_ROLE);
 111         user.setEmail(USER_EMAIL);
 112
 113         AuditEventFactory factory = new AuditUserAdminEventFactory(AuditingActionEnum.ADD_USER,
 114                 CommonAuditData.newBuilder()
 115                         .description(DESCRIPTION)
 116                         .status(STATUS_CREATED)
 117                         .requestId(REQUEST_ID)
 118                         .build(),
 119                 modifier, null, user);
 120
 121         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 122
 123         assertThat(auditingManager.auditEvent(factory)).isEqualTo(EXPECTED_ADD_USER_LOG_STR);
 124         verifyUserEvent(AuditingActionEnum.ADD_USER.getName());
 125     }
 126
 127     @Test
 128     public void testUserAdminEventForUpdateUser() {
 129
 130         user.setRole(DESIGNER_USER_ROLE);
 131         user.setEmail(USER_EMAIL);
 132
 133         User updated = new User(user);
 134         updated.setRole(TESTER_USER_ROLE);
 135
 136         AuditEventFactory builder = new AuditUserAdminEventFactory(AuditingActionEnum.UPDATE_USER,
 137                 CommonAuditData.newBuilder()
 138                         .description(DESCRIPTION)
 139                         .status(STATUS_OK)
 140                         .requestId(REQUEST_ID)
 141                         .build(),
 142                 modifier, user, updated);
 143
 144         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 145
 146         assertThat(auditingManager.auditEvent(builder)).isEqualTo(EXPECTED_UPDATE_USER_LOG_STR);
 147         verifyUserEvent(AuditingActionEnum.UPDATE_USER.getName());
 148     }
 149
 150     @Test
 151     public void testUserAdminEventForDeleteUser() {
 152
 153         user.setRole(DESIGNER_USER_ROLE);
 154         user.setEmail(USER_EMAIL);
 155
 156         AuditEventFactory factory = new AuditUserAdminEventFactory(AuditingActionEnum.DELETE_USER,
 157                 CommonAuditData.newBuilder()
 158                         .description(DESCRIPTION)
 159                         .status(STATUS_OK)
 160                         .requestId(REQUEST_ID)
 161                         .build(),
 162                 modifier, user, null);
 163
 164         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 165
 166         assertThat(auditingManager.auditEvent(factory)).isEqualTo(EXPECTED_DELETE_USER_LOG_STR);
 167         verifyUserEvent(AuditingActionEnum.DELETE_USER.getName());
 168     }
 169
 170     @Test
 171     public void testGetUserListEvent() {
 172
 173         AuditEventFactory factory = new AuditGetUsersListEventFactory(
 174                 CommonAuditData.newBuilder()
 175                         .description(DESCRIPTION)
 176                         .status(STATUS_OK)
 177                         .requestId(REQUEST_ID)
 178                         .build(),
 179                 user, USER_DETAILS);
 180
 181         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 182
 183         assertThat(auditingManager.auditEvent(factory)).isEqualTo(EXPECTED_GET_USER_LIST_LOG_STR);
 184         verifyGetUserListEvent();
 185     }
 186
 187     @Test
 188     public void testAuthRequestEvent() {
 189
 190         AuditEventFactory factory = new AuditAuthRequestEventFactory(
 191                 CommonAuditData.newBuilder()
 192                         .description(DESCRIPTION)
 193                         .status(STATUS_OK)
 194                         .requestId(REQUEST_ID)
 195                         .build(),
 196                 USER_ID, AUTH_URL, REALM, AUTH_STATUS);
 197
 198         when(cassandraDao.saveRecord(any(AuditingGenericEvent.class))).thenReturn(CassandraOperationStatus.OK);
 199
 200         assertThat(auditingManager.auditEvent(factory)).isEqualTo(EXPECTED_AUTH_REQUEST_LOG_STR);
 201         verifyAuthRequestEvent();
 202     }
 203
 204     private void verifyUserEvent(String action) {
 205         verify(cassandraDao).saveRecord(eventCaptor.capture());
 206         UserAdminEvent storedEvent = (UserAdminEvent) eventCaptor.getValue();
 207         assertThat(storedEvent.getModifier()).isEqualTo(MODIFIER_UID);
 208         assertThat(storedEvent.getDesc()).isEqualTo(DESCRIPTION);
 209 //        assertThat(storedEvent.getRequestId()).isEqualTo(REQUEST_ID); - it is not filled out by the old code!!!
 210         assertThat(storedEvent.getServiceInstanceId()).isNull();
 211         assertThat(storedEvent.getAction()).isEqualTo(action);
 212         if (action.equals(AuditingActionEnum.ADD_USER.getName())) {
 213             //TODO enable this test after deleting the old auditEvent method
 214 //            assertThat(storedEvent.getUserBefore()).isNull();
 215             assertThat(storedEvent.getUserAfter()).isEqualTo(USER_EXTENDED_NAME);
 216             assertThat(storedEvent.getStatus()).isEqualTo(STATUS_CREATED);
 217         }
 218         else if (action.equals(AuditingActionEnum.UPDATE_USER.getName())){
 219             assertThat(storedEvent.getUserBefore()).isEqualTo(USER_EXTENDED_NAME);
 220             assertThat(storedEvent.getUserAfter()).isEqualTo(UPDATED_USER_EXTENDED_NAME);
 221             assertThat(storedEvent.getStatus()).isEqualTo(STATUS_OK);
 222         }
 223         else {
 224             assertThat(storedEvent.getUserBefore()).isEqualTo(USER_EXTENDED_NAME);
 225             //TODO enable this test after deleting the old auditEvent method
 226 //            assertThat(storedEvent.getUserAfter()).isNull();
 227             assertThat(storedEvent.getStatus()).isEqualTo(STATUS_OK);
 228         }
 229     }
 230
 231     private void verifyGetUserListEvent() {
 232         verify(cassandraDao).saveRecord(eventCaptor.capture());
 233         GetUsersListEvent storedEvent = (GetUsersListEvent) eventCaptor.getValue();
 234         assertThat(storedEvent.getModifier()).isEqualTo(USER_UID);
 235         assertThat(storedEvent.getDesc()).isEqualTo(DESCRIPTION);
 236         assertThat(storedEvent.getServiceInstanceId()).isNull();
 237         assertThat(storedEvent.getAction()).isEqualTo(AuditingActionEnum.GET_USERS_LIST.getName());
 238     }
 239
 240     private void verifyUserAccessEvent() {
 241         verify(cassandraDao).saveRecord(eventCaptor.capture());
 242         UserAccessEvent storedEvent = (UserAccessEvent) eventCaptor.getValue();
 243         assertThat(storedEvent.getUserUid()).isEqualTo(USER_UID);
 244         assertThat(storedEvent.getStatus()).isEqualTo(STATUS_OK);
 245         assertThat(storedEvent.getDesc()).isEqualTo(DESCRIPTION);
 246         assertThat(storedEvent.getRequestId()).isNotBlank();
 247         assertThat(storedEvent.getServiceInstanceId()).isNull();
 248         assertThat(storedEvent.getAction()).isEqualTo(AuditingActionEnum.USER_ACCESS.getName());
 249     }
 250
 251     private void verifyAuthRequestEvent() {
 252         verify(cassandraDao).saveRecord(eventCaptor.capture());
 253         AuthEvent storedEvent = (AuthEvent) eventCaptor.getValue();
 254         assertThat(storedEvent.getUser()).isEqualTo(USER_ID);
 255         assertThat(storedEvent.getStatus()).isEqualTo(STATUS_OK);
 256         assertThat(storedEvent.getDesc()).isEqualTo(DESCRIPTION);
 257         assertThat(storedEvent.getRequestId()).isNotBlank();
 258         assertThat(storedEvent.getServiceInstanceId()).isNull();
 259         assertThat(storedEvent.getAuthStatus()).isEqualTo(AUTH_STATUS);
 260         assertThat(storedEvent.getUrl()).isEqualTo(AUTH_URL);
 261         assertThat(storedEvent.getRealm()).isEqualTo(REALM);
 262         assertThat(storedEvent.getAction()).isEqualTo(AuditingActionEnum.AUTH_REQUEST.getName());
 263     }
 264
 265 }