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

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