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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 Nordix Foundation.
   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.integration;
  21
  22 import org.testcontainers.containers.PostgreSQLContainer;
  23 import org.testcontainers.utility.DockerImageName;
  24
  25 /**
  26  * The Postgresql database test container wrapper.
  27  * Singleton implementation allows saving time on database initialization which otherwise would occur on each test.
  28  * for debugging/developing purposes you can suspend any test and connect to this database:
  29  *  docker exec -it {container-id} sh
  30  *  psql -d test -U test
  31  */
  32 public class DatabaseTestContainer extends PostgreSQLContainer<DatabaseTestContainer> {
  33     private static final String IMAGE_VERSION = "registry.nordix.org/onaptest/postgres:14.1";
  34     private static DatabaseTestContainer databaseTestContainer;
  35
  36     private DatabaseTestContainer() {
  37         super(DockerImageName.parse(IMAGE_VERSION).asCompatibleSubstituteFor("postgres"));
  38     }
  39
  40     /**
  41      * Provides an instance of test container wrapper.
  42      * The returned value expected to be assigned to static variable annotated with @ClassRule.
  43      * This will allow to initialize DB connection env variables before DataSource object
  44      * is initialized by Spring framework.
  45      *
  46      */
  47     public static DatabaseTestContainer getInstance() {
  48         if (databaseTestContainer == null) {
  49             databaseTestContainer = new DatabaseTestContainer();
  50             Runtime.getRuntime().addShutdownHook(new Thread(databaseTestContainer::terminate));
  51         }
  52         return databaseTestContainer;
  53     }
  54
  55     @Override
  56     public void start() {
  57         super.start();
  58         System.setProperty("DB_URL", databaseTestContainer.getJdbcUrl());
  59         System.setProperty("DB_USERNAME", databaseTestContainer.getUsername());
  60         System.setProperty("DB_PASSWORD", databaseTestContainer.getPassword());
  61     }
  62
  63     @Override
  64     public void stop() {
  65         // do nothing on test completion, image removal will be performed via terminate() on JVM shutdown
  66     }
  67
  68     private void terminate() {
  69         super.stop();
  70     }
  71 }