aboutsummaryrefslogtreecommitdiffstats
path: root/models-interactions/model-yaml/src/test/java/org/onap/policy/controlloop/compiler/ControlLoopCompilerTest.java
blob: 71d67f07b56dd9ac4ff1571e8a3a4a56d728c2f2 (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
/*-
 * ============LICENSE_START=======================================================
 * policy-yaml unit test
 * ================================================================================
 * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2019-2020 Nordix Foundation.
 * ================================================================================
 * 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.controlloop.compiler;

import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import org.junit.Test;
import org.onap.policy.controlloop.policy.ControlLoopPolicy;
import org.onap.policy.controlloop.policy.FinalResult;

public class ControlLoopCompilerTest {
    private static final String RESTART_UNKNOWN_POLICY =
        "Operation Policy unique-policy-id-1-restart is connected to unknown policy unknown-policy";

    @Test
    public void testTest() throws Exception {
        List<String> expectedOnErrorMessages = new ArrayList<>();
        expectedOnErrorMessages.add("Operational Policy has an bad ID");
        expectedOnErrorMessages.add("Policy id is set to a PolicyResult SUCCESS");
        expectedOnErrorMessages.add("Policy id is set to a FinalResult FINAL_SUCCESS");
        expectedOnErrorMessages.add("Policy actor is null");
        expectedOnErrorMessages.add("Policy recipe is null");
        expectedOnErrorMessages.add("Policy target is null");
        expectedOnErrorMessages.add("Policy target is invalid");
        expectedOnErrorMessages.add("Policy success is neither another policy nor FINAL_SUCCESS");
        expectedOnErrorMessages.add("Policy failure is neither another policy nor FINAL_FAILURE");
        expectedOnErrorMessages.add("Policy failure retries is neither another policy nor FINAL_FAILURE_RETRIES");
        expectedOnErrorMessages.add("Policy failure timeout is neither another policy nor FINAL_FAILURE_TIMEOUT");
        expectedOnErrorMessages.add("Policy failure exception is neither another policy nor FINAL_FAILURE_EXCEPTION");
        expectedOnErrorMessages.add("Policy failure guard is neither another policy nor FINAL_FAILURE_GUARD");
        expectedOnErrorMessages.add("Unsupported version for this compiler");
        expectedOnErrorMessages.add("controlLoop overall timeout is less than the sum of operational policy timeouts.");

        TestControlLoopCompilerCallback testControlLoopCompilerCallback =
            new TestControlLoopCompilerCallback(expectedOnErrorMessages);
        ControlLoopPolicy controlLoopPolicy =
            this.test("src/test/resources/v1.0.0/test.yaml", testControlLoopCompilerCallback);
        assertEquals(22, controlLoopPolicy.getPolicies().size());
        assertTrue(testControlLoopCompilerCallback.areAllExpectedOnErrorsReceived());
    }

    @Test
    public void testSuccessConnectedToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_success_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testFailureConnectedToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_failure_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testFailureTimeoutToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_failure_timeout_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testFailureRetriesToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_failure_retries_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testFailureExceptionToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_failure_exception_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testFailureGuardToUnknownPolicy() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_policy_failure_guard_connected_to_unknown_policy.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(RESTART_UNKNOWN_POLICY);
    }

    @Test
    public void testInvalidTriggerPolicyId() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_trigger_1.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage("Unexpected value for trigger_policy, should only be "
            + FinalResult.FINAL_OPENLOOP.toString() + " or a valid Policy ID");
    }

    @Test
    public void testNoTriggerPolicyId() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_trigger_no_trigger_id.yaml");
        }).isInstanceOf(CompilerException.class);
    }

    @Test
    public void testNoControlLoopName() throws Exception {
        List<String> expectedOnErrorMessages = new ArrayList<>();
        expectedOnErrorMessages.add("Missing controlLoopName");
        expectedOnErrorMessages.add("Unsupported version for this compiler");
        TestControlLoopCompilerCallback testControlLoopCompilerCallback =
            new TestControlLoopCompilerCallback(expectedOnErrorMessages);
        this.test("src/test/resources/v1.0.0/bad_control_loop_no_control_loop_name.yaml",
            testControlLoopCompilerCallback);
        assertTrue(testControlLoopCompilerCallback.areAllExpectedOnErrorsReceived());
    }

    @Test
    public void testInvalidFinalResult() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/bad_trigger_2.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage(
            "Unexpected Final Result for trigger_policy, should only be FINAL_OPENLOOP or a valid Policy ID");
    }

    @Test
    public void testCompileEmptyFile() throws Exception {
        assertThatThrownBy(() -> {
            this.test("src/test/resources/v1.0.0/empty.yaml");
        }).isInstanceOf(CompilerException.class).hasMessage("Could not parse yaml specification.");
    }

    public ControlLoopPolicy test(String testFile) throws Exception {
        return test(testFile, null);
    }

    /**
     * Does the actual test.
     *
     * @param testFile test file
     * @param controlLoopCompilerCallback callback method
     * @return the policy object
     * @throws Exception exception
     */
    public ControlLoopPolicy test(String testFile, ControlLoopCompilerCallback controlLoopCompilerCallback)
        throws Exception {
        try (InputStream is = new FileInputStream(new File(testFile))) {
            return ControlLoopCompiler.compile(is, controlLoopCompilerCallback);
        }
    }

    class TestControlLoopCompilerCallback implements ControlLoopCompilerCallback {

        private List<String> expectedOnErrorMessages;

        public TestControlLoopCompilerCallback(List<String> expectedOnErrorMessages) {
            this.expectedOnErrorMessages = expectedOnErrorMessages;
        }

        @Override
        public boolean onWarning(String message) {
            return true;
        }

        @Override
        public boolean onError(String message) {
            if (!expectedOnErrorMessages.remove(message)) {
                fail("Unexpected onError message: " + message);
            }
            return true;
        }

        public boolean areAllExpectedOnErrorsReceived() {
            return expectedOnErrorMessages.isEmpty();
        }
    }
}