path: root/appc-adapters/appc-iaas-adapter/appc-iaas-adapter-bundle/src/test/java/org/onap/appc/adapter/iaas/impl/TestServiceCatalogV3.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP : APPC
 * ================================================================================
 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Copyright (C) 2017 Amdocs
 * ================================================================================
 * Modifications Copyright (C) 2019 Ericsson
 * =============================================================================
 * 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.appc.adapter.iaas.impl;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.when;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import org.onap.appc.configuration.ConfigurationFactory;
import org.powermock.reflect.Whitebox;
import com.att.cdp.exceptions.ZoneException;
import com.att.cdp.zones.ContextFactory;
import com.google.common.collect.ImmutableMap;
import com.woorea.openstack.base.client.OpenStackClientConnector;
import com.woorea.openstack.base.client.OpenStackConnectException;
import com.woorea.openstack.base.client.OpenStackResponseException;
import com.woorea.openstack.keystone.v3.Keystone;
import com.woorea.openstack.keystone.v3.api.TokensResource;
import com.woorea.openstack.keystone.v3.model.Token;
import com.woorea.openstack.keystone.v3.model.Token.Service;
import com.woorea.openstack.keystone.v3.model.Token.Service.Endpoint;

/**
 * This class tests the service catalog against a known provider.
 */
@RunWith(MockitoJUnitRunner.class)
public class TestServiceCatalogV3 {

    // Number
    private static int EXPECTED_REGIONS = 1;
    private static int EXPECTED_ENDPOINTS = 1;

    private static String PRINCIPAL;
    private static String CREDENTIAL;
    private static String DOMAIN;
    private static String TENANT_NAME;
    private static String TENANT_ID;
    private static String IDENTITY_URL;
    private static String REGION_NAME;
    private static String PUBLIC_URL;

    private static String IP;
    private static String PORT;
    private static String TENANTID;
    private static String VMID;
    private static String URL;

    private ServiceCatalogV3 catalog;

    private ServiceCatalogV3 spyCatalog;

    private Properties properties;

    private Token.Project project = new Token.Project();

    private final Set<String> regions = new HashSet<>(Arrays.asList("RegionOne"));

    private Map<String, Service> serviceTypes;

    private Map<String, List<Service.Endpoint>> serviceEndpoints;

    @BeforeClass
    public static void before() {
        Properties props = ConfigurationFactory.getConfiguration().getProperties();
        IDENTITY_URL = props.getProperty("provider1.identity");
        PRINCIPAL = props.getProperty("provider1.tenant1.userid", "appc");
        CREDENTIAL = props.getProperty("provider1.tenant1.password", "appc");
        DOMAIN = props.getProperty("provider1.tenant1.domain", "Default");
        TENANT_NAME = props.getProperty("provider1.tenant1.name", "appc");
        TENANT_ID = props.getProperty("provider1.tenant1.id",
                props.getProperty("test.tenantid", "abcde12345fghijk6789lmnopq123rst"));
        REGION_NAME = props.getProperty("provider1.tenant1.region", "RegionOne");

        IP = props.getProperty("test.ip");
        PORT = props.getProperty("test.port");
        TENANTID = props.getProperty("test.tenantid");
        VMID = props.getProperty("test.vmid");

        EXPECTED_REGIONS = Integer.valueOf(props.getProperty("test.expected-regions", "0"));
        EXPECTED_ENDPOINTS = Integer.valueOf(props.getProperty("test.expected-endpoints", "0"));
        PUBLIC_URL =
                "http://192.168.1.2:5000/v2/abcde12345fghijk6789lmnopq123rst/servers/abc12345-1234-5678-890a-abcdefg12345";

    }

    /**
     * Use reflection to locate fields and methods so that they can be manipulated during the test
     * to change the internal state accordingly.
     */
    @Before
    public void setup() {
        URL = String.format("http://%s:%s/v2/%s/servers/%s", IP, PORT, TENANTID, VMID);
        properties = new Properties();
        properties.setProperty(ContextFactory.PROPERTY_PROXY_HOST, "PROXY_HOST");
        properties.setProperty(ContextFactory.PROPERTY_PROXY_PORT, "PROXY_PORT");
        catalog = new ServiceCatalogV3(IDENTITY_URL, TENANT_NAME, PRINCIPAL, CREDENTIAL, DOMAIN, properties);
        spyCatalog = Mockito.spy(catalog);
        project.setId(TENANT_ID);
        project.setName(TENANT_NAME);
        final Service service = new Service();
        serviceTypes = ImmutableMap.<String, Service>builder().put(ServiceCatalog.COMPUTE_SERVICE, service)
                .put(ServiceCatalog.IDENTITY_SERVICE, service).put(ServiceCatalog.IMAGE_SERVICE, service)
                .put(ServiceCatalog.NETWORK_SERVICE, service).put(ServiceCatalog.VOLUME_SERVICE, service).build();
        final Service.Endpoint endpoint = new Service.Endpoint();
        endpoint.setUrl(PUBLIC_URL);
        endpoint.setRegion(REGION_NAME);
        final List<Service.Endpoint> endpoints = Arrays.asList(endpoint);
        serviceEndpoints = ImmutableMap.<String, List<Service.Endpoint>>builder()
                .put(ServiceCatalog.COMPUTE_SERVICE, endpoints).build();
        Map<String, Object> privateFields =
                ImmutableMap.<String, Object>builder().put("project", project).put("regions", regions)
                        .put("serviceTypes", serviceTypes).put("serviceEndpoints", serviceEndpoints).build();
        CommonUtility.injectMockObjects(privateFields, catalog);
        CommonUtility.injectMockObjectsInBaseClass(privateFields, catalog);
    }

    /**
     * Ensure that we get the Tenant Name & Tenant Id property are returned correctly
     */
    @Test
    public void testKnownTenant() {
        when(spyCatalog.getProject()).thenReturn(project);
        assertEquals(TENANT_NAME, catalog.getProjectName());
        assertEquals(TENANT_ID, catalog.getProjectId());
    }

    /**
     * Ensure that we set up the Region property correctly
     */
    @Test
    public void testKnownRegions() {
        assertEquals(EXPECTED_REGIONS, catalog.getRegions().size());
        assertEquals(REGION_NAME, catalog.getRegions().toArray()[0]);
    }

    /**
     * Ensure that that we can check for published services correctly
     */
    @Test
    public void testServiceTypesPublished() {
        assertTrue(catalog.isServicePublished("compute"));
        assertFalse(catalog.isServicePublished("bogus"));
    }

    /**
     * Ensure that we can get the list of published services
     */
    @Test
    public void testPublishedServicesList() {
        List<String> services = catalog.getServiceTypes();
        assertTrue(services.contains(ServiceCatalog.COMPUTE_SERVICE));
        assertTrue(services.contains(ServiceCatalog.IDENTITY_SERVICE));
        assertTrue(services.contains(ServiceCatalog.IMAGE_SERVICE));
        assertTrue(services.contains(ServiceCatalog.NETWORK_SERVICE));
        assertTrue(services.contains(ServiceCatalog.VOLUME_SERVICE));
    }

    /**
     * Ensure that we can get the endpoint(s) for a service
     */
    @Test
    public void testEndpointList() {
        List<Endpoint> endpoints = catalog.getEndpoints(ServiceCatalog.COMPUTE_SERVICE);
        assertNotNull(endpoints);
        assertFalse(endpoints.isEmpty());
        assertEquals(EXPECTED_ENDPOINTS, endpoints.size());
    }

    /**
     * Ensure that we override the toString method
     */
    @Test
    public void testToString() {
        String testString = catalog.toString();
        assertNotNull(testString);
    }

    /**
     * Ensure that we can get the VM Region
     */
    @Test
    public void testGetVMRegion() {
        VMURL url = VMURL.parseURL(URL);
        String region = catalog.getVMRegion(url);
        assertEquals(REGION_NAME, region);
    }

    /**
     * Ensure that we can get the null region when no URL is passed
     */
    @Test
    public void testGetVMRegionWithoutURL() {
        String region = catalog.getVMRegion(null);
        assertNull(region);
    }

    @Ignore
    @Test
    public void liveConnectionTest() {
        // this test should only be used by developers when testing against a live Openstack
        // instance, otherwise it should be ignored
        properties = new Properties();
        String identity = "";
        String tenantName = "";
        String user = "";
        String pass = "";

        catalog = new ServiceCatalogV3(IDENTITY_URL, TENANT_NAME, PRINCIPAL, CREDENTIAL, DOMAIN, properties);
    }

    @Test
    public void testInit() throws ZoneException, ClassNotFoundException, InstantiationException, IllegalAccessException, OpenStackConnectException, OpenStackResponseException {
        ServiceCatalogV3 catalogSpy = Mockito.spy(catalog);
        Class<?> connectorClass = Class.forName(ServiceCatalogV2.CLIENT_CONNECTOR_CLASS);
        OpenStackClientConnector connector = (OpenStackClientConnector) connectorClass.newInstance();
        Keystone keystone = Mockito.spy(new Keystone(IDENTITY_URL, connector));
        TokensResource tokens = Mockito.mock(TokensResource.class);
        TokensResource.Authenticate authenticate = Mockito.mock(TokensResource.Authenticate.class);
        Mockito.when(keystone.tokens()).thenReturn(tokens);
        Mockito.when(tokens.authenticate(Mockito.any())).thenReturn(authenticate);
        Token token = Mockito.mock(Token.class);

        Mockito.when(authenticate.execute()).thenReturn(token);
        //Mockito.when(authenticate.withTenantName(Mockito.anyString())).thenReturn(authenticate);
        Mockito.when(catalogSpy.getKeystone(Mockito.anyString(), Mockito.any())).thenReturn(keystone);
        Endpoint endpoint = new Endpoint();
        List<Endpoint> endpointList = new ArrayList<>();
        endpointList.add(endpoint);
        List<Token.Service> serviceList = new ArrayList<>();
        Token.Service service = new Token.Service();
        Whitebox.setInternalState(service, "endpoints", endpointList);
        serviceList.add(service);
        Mockito.when(token.getCatalog()).thenReturn(serviceList);
        catalogSpy.init();
        Mockito.verify(token).getCatalog();
    }
}