aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-cdap-tca/src/test/java/org/onap/dcae/apod/analytics/cdap/tca/flowlet/TCAVESAlertsAbatementFlowletTest.java
blob: 7755a1380aa07e871d47b593bde154b4fb9edbb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 AT&T Intellectual Property. 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.dcae.apod.analytics.cdap.tca.flowlet;

import co.cask.cdap.api.dataset.lib.ObjectMappedTable;
import co.cask.cdap.api.flow.flowlet.FlowletContext;
import co.cask.cdap.api.flow.flowlet.OutputEmitter;
import com.google.common.collect.ImmutableList;
import org.junit.Test;
import org.onap.dcae.apod.analytics.cdap.common.CDAPComponentsConstants;
import org.onap.dcae.apod.analytics.cdap.common.domain.tca.ThresholdCalculatorOutput;
import org.onap.dcae.apod.analytics.cdap.common.exception.CDAPSettingsException;
import org.onap.dcae.apod.analytics.cdap.common.persistance.tca.TCAAlertsAbatementEntity;
import org.onap.dcae.apod.analytics.cdap.tca.BaseAnalyticsCDAPTCAUnitTest;
import org.onap.dcae.apod.analytics.cdap.tca.settings.TCAPolicyPreferences;
import org.onap.dcae.apod.analytics.model.domain.policy.tca.ClosedLoopEventStatus;
import org.onap.dcae.apod.analytics.model.domain.policy.tca.MetricsPerEventName;
import org.onap.dcae.apod.analytics.model.domain.policy.tca.Threshold;
import org.onap.dcae.apod.analytics.tca.utils.TCAUtils;

import java.util.Date;
import java.util.List;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
 * @author Rajiv Singla . Creation Date: 9/12/2017.
 */
@SuppressWarnings("unchecked")
public class TCAVESAlertsAbatementFlowletTest extends BaseAnalyticsCDAPTCAUnitTest {

    private static final TCAPolicyPreferences sampleTCAPolicyPreferences = getSampleTCAPolicyPreferences();
    private static final List<MetricsPerEventName> metricsPerEventNames = sampleTCAPolicyPreferences
            .getMetricsPerEventName();
    private final OutputEmitter<String> mockOutputEmitter = mock(OutputEmitter.class);

    private class TestTCAVESAlertsAbatementFlowlet extends TCAVESAlertsAbatementFlowlet {

        public TestTCAVESAlertsAbatementFlowlet(String tcaAlertsAbatementTableName) {
            super(tcaAlertsAbatementTableName);
            this.alertsAbatementOutputEmitter = mockOutputEmitter;
            doNothing().when(mockOutputEmitter).emit(any(String.class));
        }
    }

    @Test
    public void testConfigure() throws Exception {
        final TCAVESAlertsAbatementFlowlet tcavesAlertsAbatementFlowlet =
                new TCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");
        assertFlowletNameAndDescription(CDAPComponentsConstants.TCA_FIXED_VES_ALERTS_ABATEMENT_NAME_FLOWLET,
                CDAPComponentsConstants.TCA_FIXED_VES_ALERTS_ABATEMENT_DESCRIPTION_FLOWLET,
                tcavesAlertsAbatementFlowlet);
    }

    @Test(expected = CDAPSettingsException.class)
    public void testDetermineAbatementAlertsWhenViolatedMetricsEventNameIsBlank() throws Exception {

        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");
        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.ONSET);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);
        when(mockThresholdCalculatorOutput.getViolatedMetricsPerEventName()).thenReturn("");

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);
    }

    @Test
    public void testDetermineAbatementAlertsWhenControlLoopTypeIsONSET() throws Exception {

        final String testTCAAlertsAbatementTableName = "testTCAAlertsAbatementTableName";
        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");

        final FlowletContext mockFlowletContext = mock(FlowletContext.class);
        final ObjectMappedTable<TCAAlertsAbatementEntity> mockObjectMappedTable = mock(ObjectMappedTable.class);
        when(mockFlowletContext.getDataset(eq(testTCAAlertsAbatementTableName))).thenReturn(mockObjectMappedTable);
        tcaAlertsAbatementFlowlet.initialize(mockFlowletContext);

        doNothing().when(mockObjectMappedTable).write(any(String.class), any(TCAAlertsAbatementEntity.class));

        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.ONSET);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);
        verify(mockObjectMappedTable,
                times(1)).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        verify(mockOutputEmitter, times(1)).emit(any(String.class));

    }


    @Test
    public void testDetermineAbatementAlertsWhenControlLoopTypeIsABATEDAndNoPreviousAlertWasSent() throws Exception {

        final String testTCAAlertsAbatementTableName = "testTCAAlertsAbatementTableName";
        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");

        final FlowletContext mockFlowletContext = mock(FlowletContext.class);
        final ObjectMappedTable<TCAAlertsAbatementEntity> mockObjectMappedTable = mock(ObjectMappedTable.class);
        when(mockFlowletContext.getDataset(eq(testTCAAlertsAbatementTableName))).thenReturn(mockObjectMappedTable);
        tcaAlertsAbatementFlowlet.initialize(mockFlowletContext);

        doNothing().when(mockObjectMappedTable).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        final TCAAlertsAbatementEntity tcaAlertsAbatementEntity = mock(TCAAlertsAbatementEntity.class);
        when(mockObjectMappedTable.read(any(String.class))).thenReturn(tcaAlertsAbatementEntity);
        when(tcaAlertsAbatementEntity.getAbatementSentTS()).thenReturn(null);

        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.ABATED);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);
        verify(mockObjectMappedTable,
                times(1)).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        verify(mockOutputEmitter, times(1)).emit(any(String.class));

    }

    @Test
    public void testDetermineAbatementAlertsWhenControlLoopTypeIsABATEDAndPreviousAlertWasAlreadySent() throws
            Exception {

        final String testTCAAlertsAbatementTableName = "testTCAAlertsAbatementTableName";
        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");

        final FlowletContext mockFlowletContext = mock(FlowletContext.class);
        final ObjectMappedTable<TCAAlertsAbatementEntity> mockObjectMappedTable = mock(ObjectMappedTable.class);
        when(mockFlowletContext.getDataset(eq(testTCAAlertsAbatementTableName))).thenReturn(mockObjectMappedTable);
        tcaAlertsAbatementFlowlet.initialize(mockFlowletContext);

        doNothing().when(mockObjectMappedTable).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        final TCAAlertsAbatementEntity tcaAlertsAbatementEntity = mock(TCAAlertsAbatementEntity.class);
        when(mockObjectMappedTable.read(any(String.class))).thenReturn(tcaAlertsAbatementEntity);
        final long time = new Date().getTime();
        when(tcaAlertsAbatementEntity.getAbatementSentTS()).thenReturn(Long.toString(time));

        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.ABATED);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);
        verify(mockObjectMappedTable,
                times(0)).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        verify(mockOutputEmitter, times(0)).emit(any(String.class));

    }


    @Test
    public void testDetermineAbatementAlertsWhenControlLoopTypeIsABATEDAndNoPreviousONSETEventFound() throws
            Exception {

        final String testTCAAlertsAbatementTableName = "testTCAAlertsAbatementTableName";
        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");

        final FlowletContext mockFlowletContext = mock(FlowletContext.class);
        final ObjectMappedTable<TCAAlertsAbatementEntity> mockObjectMappedTable = mock(ObjectMappedTable.class);
        when(mockFlowletContext.getDataset(eq(testTCAAlertsAbatementTableName))).thenReturn(mockObjectMappedTable);
        tcaAlertsAbatementFlowlet.initialize(mockFlowletContext);

        doNothing().when(mockObjectMappedTable).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        when(mockObjectMappedTable.read(any(String.class))).thenReturn(null);

        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.ABATED);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);
        verify(mockObjectMappedTable,
                times(0)).write(any(String.class), any(TCAAlertsAbatementEntity.class));
        verify(mockOutputEmitter, times(0)).emit(any(String.class));

    }

    @Test(expected = CDAPSettingsException.class)
    public void testDetermineAbatementAlertsWhenControlLoopTypeIsNotOnsetOrAbated() throws
            Exception {
        final TestTCAVESAlertsAbatementFlowlet tcaAlertsAbatementFlowlet =
                new TestTCAVESAlertsAbatementFlowlet("testTCAAlertsAbatementTableName");
        final Threshold violatedThreshold = getViolatedThreshold(ClosedLoopEventStatus.CONTINUE);
        final ThresholdCalculatorOutput mockThresholdCalculatorOutput =
                getMockThresholdCalculatorOutput(violatedThreshold);

        tcaAlertsAbatementFlowlet.determineAbatementAlerts(mockThresholdCalculatorOutput);

    }

    private static Threshold getViolatedThreshold(final ClosedLoopEventStatus closedLoopEventStatus) {
        final Threshold violatedThreshold = Threshold.copy(metricsPerEventNames.get(0).getThresholds().get(0));
        violatedThreshold.setClosedLoopEventStatus(closedLoopEventStatus);
        return violatedThreshold;
    }


    private static ThresholdCalculatorOutput getMockThresholdCalculatorOutput(final Threshold violatedThreshold) throws
            Exception {

        final MetricsPerEventName violatedMetricsPerEventName =
                MetricsPerEventName.copy(metricsPerEventNames.get(0));
        violatedMetricsPerEventName.setThresholds(ImmutableList.of(violatedThreshold));
        return getMockThresholdCalculatorOutput(
                fromStream(CEF_MESSAGE_JSON_FILE_LOCATION),
                fromStream(TCA_POLICY_JSON_FILE_LOCATION),
                TCAUtils.writeValueAsString(violatedMetricsPerEventName),
                fromStream(TCA_ALERT_JSON_FILE_LOCATION)
        );
    }


    private static ThresholdCalculatorOutput getMockThresholdCalculatorOutput(final String cefMessage,
                                                                              final String tcaPolicy,
                                                                              final String violatedMetricsPerEventName,
                                                                              final String alertMessage) {
        final ThresholdCalculatorOutput thresholdCalculatorOutput = mock(ThresholdCalculatorOutput.class);
        when(thresholdCalculatorOutput.getCefMessage()).thenReturn(cefMessage);
        when(thresholdCalculatorOutput.getTcaPolicy()).thenReturn(tcaPolicy);
        when(thresholdCalculatorOutput.getViolatedMetricsPerEventName()).thenReturn(violatedMetricsPerEventName);
        when(thresholdCalculatorOutput.getAlertMessage()).thenReturn(alertMessage);
        return thresholdCalculatorOutput;
    }

}