aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/test/java/org/onap/policy/common/utils/properties/exception/SupportBasicPropertyExceptionTester.java
blob: 97503f8cf9b7e94f1a5b6e2b4659bd8c72f233d5 (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
/*
 * ============LICENSE_START=======================================================
 * ONAP Policy Engine - Common Modules
 * ================================================================================
 * Copyright (C) 2018 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.policy.common.utils.properties.exception;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;

import org.hamcrest.CoreMatchers;

/**
 * Superclass used to test subclasses of {@link PropertyException}.
 */
public class SupportBasicPropertyExceptionTester {

    /**
     * The "message" that's passed each time an exception is constructed.
     */
    protected static final String MESSAGE = "some error";

    /**
     * The "throwable" that's passed each time an exception is constructed.
     */
    protected static final Throwable THROWABLE = new Throwable();

    /**
     * Name of the "property" to be passed each time an exception is constructed.
     */
    protected static final String PROPERTY = "myName";

    /**
     * Name of the "property" field.
     */
    protected static final String FIELD = "PROPERTY";

    /*
     * Methods to perform various tests on the except subclass. 
     */

    protected void doTestPropertyExceptionStringField_AllPopulated(PropertyException ex) {
        standardTests(ex);
    }

    protected void doTestPropertyExceptionStringField_NullProperty(PropertyException ex) {
        assertEquals(null, ex.getPropertyName());
        assertEquals(FIELD, ex.getFieldName());
        assertNotNull(ex.getMessage());
        assertNotNull(ex.toString());
    }

    protected void doTestPropertyExceptionStringField_NullField(PropertyException ex) {
        assertEquals(PROPERTY, ex.getPropertyName());
        assertEquals(null, ex.getFieldName());
        assertNotNull(ex.getMessage());
        assertNotNull(ex.toString());
    }

    protected void doTestPropertyExceptionStringField_BothNull(PropertyException ex) {
        assertEquals(null, ex.getPropertyName());
        assertEquals(null, ex.getFieldName());
        assertNotNull(ex.getMessage());
        assertNotNull(ex.toString());
    }

    protected void doTestPropertyExceptionStringFieldString(PropertyException ex) {
        standardTests(ex);
        standardMessageTests(ex);
    }

    protected void doTestPropertyExceptionStringFieldThrowable(PropertyException ex) {
        standardTests(ex);
        standardThrowableTests(ex);
    }

    protected void doTestPropertyExceptionStringFieldStringThrowable(PropertyException ex) {
        standardTests(ex);
        standardMessageTests(ex);
        standardThrowableTests(ex);
    }

    /**
     * Performs standard tests that should apply to all subclasses.
     * 
     * @param ex exception to test
     */
    protected void standardTests(PropertyException ex) {
        assertEquals(PROPERTY, ex.getPropertyName());
        assertEquals(FIELD, ex.getFieldName());
        assertNotNull(ex.getMessage());
        assertNotNull(ex.toString());
    }

    /**
     * Performs standard tests for exceptions that were provided a message in their
     * constructor.
     * 
     * @param ex exception to test
     */
    protected void standardMessageTests(PropertyException ex) {
        assertThat(ex.getMessage(), CoreMatchers.endsWith(MESSAGE));
    }

    /**
     * Performs standard tests for exceptions that were provided a throwable in their
     * constructor.
     * 
     * @param ex exception to test
     */
    protected void standardThrowableTests(PropertyException ex) {
        assertEquals(THROWABLE, ex.getCause());
    }

}