cps-ri/src/test/java/org/onap/cps/DatabaseTestContainer.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Pantheon.tech
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.cps;
  21
  22 import org.testcontainers.containers.PostgreSQLContainer;
  23
  24 /**
  25  * The Postgresql database test container wrapper.
  26  * Singleton implementation allows saving time on database initialization which otherwise would occur on each test.
  27  * for debugging/developing purposes you can suspend any test and connect to this database:
  28  *  docker exec -it {container-id} sh
  29  *  psql -d test -U test
  30  */
  31 public class DatabaseTestContainer extends PostgreSQLContainer<DatabaseTestContainer> {
  32     private static final String IMAGE_VERSION = "postgres:13.2";
  33     private static DatabaseTestContainer databaseTestContainer;
  34
  35     private DatabaseTestContainer() {
  36         super(IMAGE_VERSION);
  37     }
  38
  39     /**
  40      * Provides an instance of test container wrapper.
  41      * The returned value expected to be assigned to static variable annotated with @ClassRule.
  42      * This will allow to initialize DB connection env variables before DataSource object
  43      * is initialized by Spring framework.
  44      *
  45      */
  46     public static DatabaseTestContainer getInstance() {
  47         if (databaseTestContainer == null) {
  48             databaseTestContainer = new DatabaseTestContainer();
  49             Runtime.getRuntime().addShutdownHook(new Thread(databaseTestContainer::terminate));
  50         }
  51         return databaseTestContainer;
  52     }
  53
  54     @Override
  55     public void start() {
  56         super.start();
  57         System.setProperty("DB_URL", databaseTestContainer.getJdbcUrl());
  58         System.setProperty("DB_USERNAME", databaseTestContainer.getUsername());
  59         System.setProperty("DB_PASSWORD", databaseTestContainer.getPassword());
  60     }
  61
  62     @Override
  63     public void stop() {
  64         // do nothing on test completion, image removal will be performed via terminate() on JVM shutdown
  65     }
  66
  67     private void terminate() {
  68         super.stop();
  69     }
  70 }