aboutsummaryrefslogtreecommitdiffstats
path: root/common-logging/src/test/java/org/onap/policy/common/logging/flexlogger/PropertyUtilTest.java
blob: bbf77179de406acf12e650ec50d3005a7ec7cc47 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP-Logging
 * ================================================================================
 * Copyright (C) 2018-2020 Ericsson, AT&T. 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.logging.flexlogger;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;
import java.util.Set;
import java.util.Timer;
import java.util.TimerTask;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.onap.policy.common.logging.flexlogger.PropertyUtil.Listener;
import org.powermock.reflect.Whitebox;

public class PropertyUtilTest {

    private static final String TIMER_FIELD = "timer";
    private static final File FILE = new File("target/test.properties");
    private static Timer saveTimer;
    
    private TimerTask task;
    private Timer timer;
    private TestListener testListener;
    
    @BeforeClass
    public static void setUpBeforeClass() {
        saveTimer = Whitebox.getInternalState(PropertyUtil.LazyHolder.class, TIMER_FIELD);
        
    }
    
    @AfterClass
    public static void tearDownAfterClass() {
        Whitebox.setInternalState(PropertyUtil.LazyHolder.class, TIMER_FIELD, saveTimer);
        
    }

    /**
     * Perform test case set up.
     */
    @Before
    public void setUp() throws IOException {
        task = null;
        timer = mock(Timer.class);
        Whitebox.setInternalState(PropertyUtil.LazyHolder.class, TIMER_FIELD, timer);
        
        doAnswer(args -> {
            task = args.getArgument(0, TimerTask.class);
            return null;
        }).when(timer).schedule(any(TimerTask.class), anyLong(), anyLong());
        
        testListener = new TestListener();
        
        FileOutputStream fileOutputStream = new FileOutputStream(FILE);
        Properties properties = new Properties();
        properties.put("testProperty", "testValue");
        properties.store(fileOutputStream, "");
        fileOutputStream.close();
    }

    @After
    public void tearDown() throws IOException {
        PropertyUtil.stopListening(FILE, testListener);
        FILE.delete();
    }
    
    @Test
    public void testTimer() {
        assertNotNull(saveTimer);
    }

    @Test
    public void testGetProperties() throws IOException {
        FileOutputStream fileOutputStream = new FileOutputStream(FILE);
        Properties properties = new Properties();
        properties.put("testProperty", "testValue");
        properties.store(fileOutputStream, "");
        fileOutputStream.close();

        Properties readProperties = PropertyUtil.getProperties(FILE, testListener);
        assertEquals("testValue", readProperties.getProperty("testProperty"));
    }

    @Test
    public void testPropertiesChanged() throws IOException, InterruptedException {
        PropertyUtil.getProperties(FILE, testListener);

        FileOutputStream fileOutputStream = new FileOutputStream(FILE);
        Properties newProperties = new Properties();
        newProperties.put("testProperty", "testValueNew");
        newProperties.store(fileOutputStream, "");

        // fire task and verify that it notifies the listener
        task.run();
        assertTrue(testListener.isPropertiesChangedInvoked());

    }

    @Test
    public void testStopListening() throws IOException {
        FileOutputStream fileOutputStream = new FileOutputStream(FILE);
        Properties properties = new Properties();
        properties.put("testProperty", "testValue");
        properties.store(fileOutputStream, "");

        Properties readProperties = PropertyUtil.getProperties(FILE, testListener);
        assertEquals("testValue", readProperties.getProperty("testProperty"));

        PropertyUtil.stopListening(FILE, testListener);

        properties.put("testProperty", "testValueNew");
        properties.store(fileOutputStream, "");
        fileOutputStream.close();
        readProperties = PropertyUtil.getProperties(FILE, testListener);
        // If stopListening did not remove the listener, the properties file will not be re-read
        // until poll expires and
        // hence "testValue" will be returned here instead of "testNewValue"
        assertEquals("testValueNew", readProperties.getProperty("testProperty"));
    }

    /**
     * The {@link #propertiesChanged(Properties, Set)} method is invoked via a background
     * thread, thus we have to use a latch to wait for it to be invoked.
     */
    private class TestListener implements Listener {

        private CountDownLatch latch = new CountDownLatch(1);

        @Override
        public void propertiesChanged(Properties properties, Set<String> changedKeys) {
            latch.countDown();
        }

        public boolean isPropertiesChangedInvoked() throws InterruptedException {
            return latch.await(5, TimeUnit.SECONDS);
        }
    }

}