aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/test/java/org/onap/policy/common/utils/services/OrderedServiceImplTest.java
blob: 39c8a2beed6daa5e75301736665aabfabe265ef0 (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
/*
 * ============LICENSE_START=======================================================
 * utils
 * ================================================================================
 * Copyright (C) 2019 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.services;

import static org.junit.Assert.assertEquals;

import java.util.List;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

public class OrderedServiceImplTest {

    private static final int HIGH_PRIORITY_NUM = -1000;
    private static final int LOW_PRIORITY_NUM = 1000;

    private static GenericService highPrioService;
    private static GenericService lowPrioService;

    /**
     * Saves the original state of the ordered service list to restore after each test.
     */
    @BeforeClass
    public static void setup() {
        List<GenericService> implementers = GenericService.providers.getList();
        highPrioService = implementers.get(0);
        lowPrioService = implementers.get(1);
    }

    /**
     * Restores original state after each test.
     */
    @Before
    public void resetOrder() {
        highPrioService.setSequenceNumber(HIGH_PRIORITY_NUM);
        lowPrioService.setSequenceNumber(LOW_PRIORITY_NUM);
    }

    /**
     * Tests obtaining a list of service implementers.
     */
    @Test
    public void getListTest() {
        List<GenericService> implementers = GenericService.providers.getList();
        assertEquals(2, implementers.size());

        assertEquals(highPrioService, implementers.get(0));
        assertEquals(HIGH_PRIORITY_NUM, highPrioService.getSequenceNumber());

        assertEquals(lowPrioService, implementers.get(1));
        assertEquals(LOW_PRIORITY_NUM, lowPrioService.getSequenceNumber());
    }

    /**
     * Tests inverting the priority of two services to ensure the list is rebuilt
     * with the new order.
     */
    @Test
    public void rebuildListInvertedPriorityTest() {

        List<GenericService> implementers = GenericService.providers.getList();
        assertEquals(2, implementers.size());

        assertEquals(highPrioService, implementers.get(0));
        assertEquals(HIGH_PRIORITY_NUM, highPrioService.getSequenceNumber());

        assertEquals(lowPrioService, implementers.get(1));
        assertEquals(LOW_PRIORITY_NUM, lowPrioService.getSequenceNumber());

        highPrioService.setSequenceNumber(LOW_PRIORITY_NUM);
        lowPrioService.setSequenceNumber(HIGH_PRIORITY_NUM);

        implementers = GenericService.providers.rebuildList();
        assertEquals(2, implementers.size());

        assertEquals(lowPrioService, implementers.get(0));
        assertEquals(HIGH_PRIORITY_NUM, lowPrioService.getSequenceNumber());

        assertEquals(highPrioService, implementers.get(1));
        assertEquals(LOW_PRIORITY_NUM, highPrioService.getSequenceNumber());

    }

    /**
     * Tests that the service list is ordered alphabetically by class names
     * if the priorities are equivalent.
     */
    @Test
    public void rebuildListEqualPriorityTest() {

        List<GenericService> implementers = GenericService.providers.getList();
        assertEquals(2, implementers.size());

        assertEquals(highPrioService, implementers.get(0));
        assertEquals(HIGH_PRIORITY_NUM, highPrioService.getSequenceNumber());

        assertEquals(lowPrioService, implementers.get(1));
        assertEquals(LOW_PRIORITY_NUM, lowPrioService.getSequenceNumber());

        highPrioService.setSequenceNumber(LOW_PRIORITY_NUM);
        lowPrioService.setSequenceNumber(LOW_PRIORITY_NUM);

        implementers = GenericService.providers.rebuildList();
        assertEquals(2, implementers.size());

        assertEquals(highPrioService, implementers.get(0));
        assertEquals(LOW_PRIORITY_NUM, highPrioService.getSequenceNumber());

        assertEquals(lowPrioService, implementers.get(1));
        assertEquals(LOW_PRIORITY_NUM, lowPrioService.getSequenceNumber());

    }

    /**
     * Test interface that extends OrderedService to allow changing the sequence number.
     */
    public static interface GenericService extends OrderedService {

        /**
         * Providers of the GenericService interface.
         */
        OrderedServiceImpl<GenericService> providers = new OrderedServiceImpl<>(GenericService.class);

        /**
         * Sets the sequence number of the service.
         */
        public void setSequenceNumber(int seqNum);

    }

    /**
     * A high priority service class.
     */
    public static class HighPriorityService implements GenericService {

        /**
         * Defaults to a high priority.
         */
        private int seqNum = HIGH_PRIORITY_NUM;

        /**
         * {@inheritDoc}.
         */
        @Override
        public int getSequenceNumber() {
            return this.seqNum;
        }

        /**
         * {@inheritDoc}.
         */
        @Override
        public void setSequenceNumber(int seqNum) {
            this.seqNum = seqNum;
        }

    }

    /**
     * A low priority service class.
     */
    public static class LowPriorityService implements GenericService {

        /**
         * Defaults to a low priority.
         */
        private int seqNum = LOW_PRIORITY_NUM;

        /**
         * {@inheritDoc}.
         */
        @Override
        public int getSequenceNumber() {
            return this.seqNum;
        }

        /**
         * {@inheritDoc}.
         */
        @Override
        public void setSequenceNumber(int seqNum) {
            this.seqNum = seqNum;
        }

    }

}