aboutsummaryrefslogtreecommitdiffstats
path: root/feature-distributed-locking/src/test/java/org/onap/policy/distributed/locking/TargetLockTest.java
blob: 84eba6b60b85c024fa0edf0d5dd1e56cca6538e9 (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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/*
 * ============LICENSE_START=======================================================
 * feature-distributed-locking
 * ================================================================================
 * Copyright (C) 2018-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.distributed.locking;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import org.apache.commons.dbcp2.BasicDataSource;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.onap.policy.drools.core.lock.PolicyResourceLockFeatureApi.OperResult;
import org.onap.policy.drools.persistence.SystemPersistenceConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TargetLockTest {
    private static final Logger logger = LoggerFactory.getLogger(TargetLockTest.class);
    private static final int MAX_AGE_SEC = 4 * 60;
    private static final String DB_CONNECTION =
            "jdbc:h2:mem:pooling;INIT=CREATE SCHEMA IF NOT EXISTS pooling\\;SET SCHEMA pooling";
    private static final String DB_USER = "user";
    private static final String DB_PASSWORD = "password";
    private static final String EXPECTED = "expected exception";
    private static final String MY_RESOURCE = "my-resource-id";
    private static final String MY_OWNER = "my-owner";
    private static final UUID MY_UUID = UUID.randomUUID();
    private static Connection conn = null;
    private static DistributedLockingFeature distLockFeat;

    /**
     * Setup the database.
     */
    @BeforeClass
    public static void setup() {
        getDbConnection();
        createTable();
        SystemPersistenceConstants.getManager().setConfigurationDir("src/test/resources");
        distLockFeat = new DistributedLockingFeature();
        distLockFeat.afterStart(null);
    }

    /**
     * Cleanup the lock.
     */
    @AfterClass
    public static void cleanUp() {
        distLockFeat.beforeShutdown(null);
        try {
            conn.close();
        } catch (SQLException e) {
            logger.error("Error in TargetLockTest.cleanUp()", e);
        }
    }

    /**
     * Wipe the database.
     */
    @Before
    public void wipeDb() {
        try (PreparedStatement lockDelete = conn.prepareStatement("DELETE FROM pooling.locks"); ) {
            lockDelete.executeUpdate();
        } catch (SQLException e) {
            logger.error("Error in TargetLockTest.wipeDb()", e);
            throw new RuntimeException(e);
        }
    }

    @Test
    public void testGrabLockSuccess() throws InterruptedException, ExecutionException {
        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC));

        // attempt to grab expiredLock
        try (PreparedStatement updateStatement =
                conn.prepareStatement(
                  "UPDATE pooling.locks SET expirationTime = timestampadd(second, -1, now()) WHERE resourceId = ?"); ) {
            updateStatement.setString(1, "resource1");
            updateStatement.executeUpdate();

        } catch (SQLException e) {
            logger.error("Error in TargetLockTest.testGrabLockSuccess()", e);
            throw new RuntimeException(e);
        }

        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC));

        // cannot re-lock
        assertEquals(
                OperResult.OPER_DENIED, distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC));

        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));
    }

    @Test
    public void testExpiredLocks() throws Exception {

        // grab lock
        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);

        // force lock to expire
        try (PreparedStatement lockExpire =
                conn.prepareStatement(
                        "UPDATE pooling.locks SET expirationTime = timestampadd(second, -?, now())"); ) {
            lockExpire.setInt(1, MAX_AGE_SEC + 1);
            lockExpire.executeUpdate();
        }

        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeLock("resource1", "owner2", MAX_AGE_SEC));
    }

    @Test
    public void testGrabLockFail() throws InterruptedException, ExecutionException {

        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);

        assertEquals(
                OperResult.OPER_DENIED, distLockFeat.beforeLock("resource1", "owner2", MAX_AGE_SEC));
    }

    @Test
    public void testSecondGrab_UpdateOk() throws Exception {
        PreparedStatement grabLockInsert = mock(PreparedStatement.class);
        when(grabLockInsert.executeUpdate()).thenThrow(new SQLException(EXPECTED));

        PreparedStatement secondGrabUpdate = mock(PreparedStatement.class);
        when(secondGrabUpdate.executeUpdate()).thenReturn(1);

        Connection connMock = mock(Connection.class);
        when(connMock.prepareStatement(anyString())).thenReturn(grabLockInsert, secondGrabUpdate);

        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenReturn(connMock);

        assertTrue(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).lock(MAX_AGE_SEC));
    }

    @Test
    public void testSecondGrab_UpdateFail_InsertOk() throws Exception {
        PreparedStatement grabLockInsert = mock(PreparedStatement.class);
        when(grabLockInsert.executeUpdate()).thenThrow(new SQLException(EXPECTED));

        PreparedStatement secondGrabUpdate = mock(PreparedStatement.class);
        when(secondGrabUpdate.executeUpdate()).thenReturn(0);

        PreparedStatement secondGrabInsert = mock(PreparedStatement.class);
        when(secondGrabInsert.executeUpdate()).thenReturn(1);

        Connection connMock = mock(Connection.class);
        when(connMock.prepareStatement(anyString())).thenReturn(grabLockInsert, secondGrabUpdate, secondGrabInsert);

        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenReturn(connMock);

        assertTrue(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).lock(MAX_AGE_SEC));
    }

    @Test
    public void testSecondGrab_UpdateFail_InsertFail() throws Exception {
        PreparedStatement grabLockInsert = mock(PreparedStatement.class);
        when(grabLockInsert.executeUpdate()).thenThrow(new SQLException(EXPECTED));

        PreparedStatement secondGrabUpdate = mock(PreparedStatement.class);
        when(secondGrabUpdate.executeUpdate()).thenReturn(0);

        PreparedStatement secondGrabInsert = mock(PreparedStatement.class);
        when(secondGrabInsert.executeUpdate()).thenReturn(0);

        Connection connMock = mock(Connection.class);
        when(connMock.prepareStatement(anyString())).thenReturn(grabLockInsert, secondGrabUpdate, secondGrabInsert);

        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenReturn(connMock);

        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).lock(MAX_AGE_SEC));
    }

    @Test
    public void testUpdateLock() throws Exception {
        // not locked yet - refresh should fail
        assertEquals(
                OperResult.OPER_DENIED, distLockFeat.beforeRefresh("resource1", "owner1", MAX_AGE_SEC));

        // now lock it
        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC));

        // refresh should work now
        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeRefresh("resource1", "owner1", MAX_AGE_SEC));

        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));

        // expire the lock
        try (PreparedStatement updateStatement =
                conn.prepareStatement(
                  "UPDATE pooling.locks SET expirationTime = timestampadd(second, -1, now()) WHERE resourceId = ?"); ) {
            updateStatement.setString(1, "resource1");
            updateStatement.executeUpdate();
        }

        // refresh should fail now
        assertEquals(
                OperResult.OPER_DENIED, distLockFeat.beforeRefresh("resource1", "owner1", MAX_AGE_SEC));

        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));

        // test exception case
        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenThrow(new SQLException(EXPECTED));
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).refresh(MAX_AGE_SEC));
    }

    @Test
    public void testUnlock() throws Exception {
        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);

        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeUnlock("resource1", "owner1"));
        assertEquals(
                OperResult.OPER_ACCEPTED, distLockFeat.beforeLock("resource1", "owner2", MAX_AGE_SEC));

        // test exception case
        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenThrow(new SQLException(EXPECTED));
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).unlock());
    }

    @Test
    public void testIsActive() throws Exception {
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));
        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);
        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLockedBy("resource1", "owner2"));

        // isActive on expiredLock
        try (PreparedStatement updateStatement =
                conn.prepareStatement(
                  "UPDATE pooling.locks SET expirationTime = timestampadd(second, -5, now()) WHERE resourceId = ?"); ) {
            updateStatement.setString(1, "resource1");
            updateStatement.executeUpdate();
        }

        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));

        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);
        // Unlock record, next isActive attempt should fail
        distLockFeat.beforeUnlock("resource1", "owner1");
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLockedBy("resource1", "owner1"));

        // test exception case for outer "try"
        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenThrow(new SQLException(EXPECTED));
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).isActive());

        // test exception case for inner "try"
        PreparedStatement stmt = mock(PreparedStatement.class);
        when(stmt.executeQuery()).thenThrow(new SQLException(EXPECTED));
        Connection connMock = mock(Connection.class);
        when(connMock.prepareStatement(anyString())).thenReturn(stmt);
        dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenReturn(connMock);
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).isActive());
    }

    @Test
    public void unlockBeforeLock() {
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeUnlock("resource1", "owner1"));
        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);
        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeUnlock("resource1", "owner1"));
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeUnlock("resource1", "owner1"));
    }

    @Test
    public void testIsLocked() throws Exception {
        assertEquals(OperResult.OPER_DENIED, distLockFeat.beforeIsLocked("resource1"));
        distLockFeat.beforeLock("resource1", "owner1", MAX_AGE_SEC);
        assertEquals(OperResult.OPER_ACCEPTED, distLockFeat.beforeIsLocked("resource1"));

        // test exception case for outer "try"
        BasicDataSource dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenThrow(new SQLException(EXPECTED));
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).isLocked());

        // test exception case for inner "try"
        PreparedStatement stmt = mock(PreparedStatement.class);
        when(stmt.executeQuery()).thenThrow(new SQLException(EXPECTED));
        Connection connMock = mock(Connection.class);
        when(connMock.prepareStatement(anyString())).thenReturn(stmt);
        dataSrc = mock(BasicDataSource.class);
        when(dataSrc.getConnection()).thenReturn(connMock);
        assertFalse(new TargetLock(MY_RESOURCE, MY_UUID, MY_OWNER, dataSrc).isLocked());
    }

    private static void getDbConnection() {
        try {
            conn = DriverManager.getConnection(DB_CONNECTION, DB_USER, DB_PASSWORD);
        } catch (SQLException e) {
            logger.error("Error in TargetLockTest.getDBConnection()", e);
        }
    }

    private static void createTable() {
        String createString =
                "create table if not exists pooling.locks "
                + "(resourceId VARCHAR(128), host VARCHAR(128), owner VARCHAR(128), "
                + "expirationTime TIMESTAMP DEFAULT 0, PRIMARY KEY (resourceId))";
        try (PreparedStatement createStmt = conn.prepareStatement(createString); ) {
            createStmt.executeUpdate();

        } catch (SQLException e) {
            logger.error("Error in TargetLockTest.createTable()", e);
        }
    }
}