appc-adapters/appc-iaas-adapter/appc-iaas-adapter-bundle/src/main/java/org/onap/appc/adapter/iaas/impl/ServiceCatalogV3.java

   1 /*-\r
   2  * ============LICENSE_START=======================================================\r
   3  * ONAP : APPC\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  * Copyright (C) 2017 Amdocs\r
   8  * =============================================================================\r
   9  * Modifications Copyright © 2018 IBM.\r
  10  * =============================================================================\r
  11  * Licensed under the Apache License, Version 2.0 (the "License");\r
  12  * you may not use this file except in compliance with the License.\r
  13  * You may obtain a copy of the License at\r
  14  *\r
  15  *      http://www.apache.org/licenses/LICENSE-2.0\r
  16  *\r
  17  * Unless required by applicable law or agreed to in writing, software\r
  18  * distributed under the License is distributed on an "AS IS" BASIS,\r
  19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  20  * See the License for the specific language governing permissions and\r
  21  * limitations under the License.\r
  22  *\r
  23  * ============LICENSE_END=========================================================\r
  24  */\r
  25 \r
  26 package org.onap.appc.adapter.iaas.impl;\r
  27 \r
  28 import java.util.ArrayList;\r
  29 import java.util.Calendar;\r
  30 import java.util.Date;\r
  31 import java.util.HashMap;\r
  32 import java.util.HashSet;\r
  33 import java.util.List;\r
  34 import java.util.Map;\r
  35 import java.util.Properties;\r
  36 import java.util.Set;\r
  37 import java.util.concurrent.locks.Lock;\r
  38 import java.util.concurrent.locks.ReentrantReadWriteLock;\r
  39 import java.util.regex.Matcher;\r
  40 import java.util.regex.Pattern;\r
  41 import com.att.cdp.exceptions.ContextConnectionException;\r
  42 import com.att.cdp.exceptions.ZoneException;\r
  43 import com.att.cdp.openstack.util.ExceptionMapper;\r
  44 import com.att.cdp.pal.util.Time;\r
  45 import com.att.cdp.zones.ContextFactory;\r
  46 import com.att.cdp.zones.spi.RequestState;\r
  47 import com.woorea.openstack.base.client.OpenStackBaseException;\r
  48 import com.woorea.openstack.base.client.OpenStackClientConnector;\r
  49 import com.woorea.openstack.base.client.OpenStackSimpleTokenProvider;\r
  50 import com.woorea.openstack.keystone.v3.Keystone;\r
  51 import com.woorea.openstack.keystone.v3.api.TokensResource;\r
  52 import com.woorea.openstack.keystone.v3.model.Authentication;\r
  53 import com.woorea.openstack.keystone.v3.model.Authentication.Identity;\r
  54 import com.woorea.openstack.keystone.v3.model.Authentication.Scope;\r
  55 import com.woorea.openstack.keystone.v3.model.Token;\r
  56 import com.woorea.openstack.keystone.v3.model.Token.Project;\r
  57 import com.woorea.openstack.keystone.v3.model.Token.Service;\r
  58 import com.woorea.openstack.keystone.v3.model.Token.Service.Endpoint;\r
  59 \r
  60 /**\r
  61  * This class is used to capture and cache the service catalog for a specific OpenStack provider.\r
  62  * <p>\r
  63  * This is needed because the way the servers are represented in the ECOMP product is as their fully qualified URL's.\r
  64  * This is very problematic, because we cant identify their region from the URL, URL's change, and we cant identify the\r
  65  * versions of the service implementations. In otherwords, the URL does not provide us enough information.\r
  66  * </p>\r
  67  * <p>\r
  68  * The zone abstraction layer is designed to detect the versions of the services dynamically, and step up or down to\r
  69  * match those reported versions. In order to do that, we need to know before hand what region we are accessing (since\r
  70  * the supported versions may be different by regions). We will need to authenticate to the identity service in order to\r
  71  * do this, plus we have to duplicate the code supporting proxies and trusted hosts that exists in the abstraction\r
  72  * layer, but that cant be helped.\r
  73  * </p>\r
  74  * <p>\r
  75  * What we do to circumvent this is connect to the provider using the lowest supported identity api, and read the entire\r
  76  * service catalog into this object. Then, we parse the vm URL to extract the host and port and match that to the\r
  77  * compute services defined in the catalog. When we find a compute service that has the same host name and port,\r
  78  * whatever region that service is supporting is the region for that server.\r
  79  * </p>\r
  80  * <p>\r
  81  * While we really only need to do this for compute nodes, there is no telling what other situations may arise where the\r
  82  * full service catalog may be needed. Also, there is very little additional cost (additional RAM) associated with\r
  83  * caching the full service catalog since there is no way to list only a portion of it.\r
  84  * </p>\r
  85  */\r
  86 public class ServiceCatalogV3 extends ServiceCatalog {\r
  87 \r
  88     /**\r
  89      * The project that we are accessing\r
  90      */\r
  91     private Project project;\r
  92 \r
  93     /**\r
  94      * A map of endpoints for each service organized by service type\r
  95      */\r
  96     private Map<String /* Service Type */, List<Service.Endpoint>> serviceEndpoints;\r
  97 \r
  98     /**\r
  99      * A map of service types that are published\r
 100      */\r
 101     private Map<String /* Service Type */, Service> serviceTypes;\r
 102 \r
 103     /**\r
 104      * The Openstack Access object that manages the authenticated token and access control\r
 105      */\r
 106     private Token token;\r
 107 \r
 108     /**\r
 109      * A "token provider" that manages the authentication token that we obtain when logging in\r
 110      */\r
 111     private OpenStackSimpleTokenProvider tokenProvider;\r
 112 \r
 113     /**\r
 114      * {@inheritDoc}\r
 115      */\r
 116     public ServiceCatalogV3(String identityURL, String projectIdentifier, String principal, String credential,\r
 117         String domain, Properties properties) {\r
 118         super(identityURL, projectIdentifier, principal, credential, domain, properties);\r
 119     }\r
 120 \r
 121     /**\r
 122      * {@inheritDoc}\r
 123      */\r
 124     @Override\r
 125     public void init() throws ZoneException {\r
 126         rwLock = new ReentrantReadWriteLock();\r
 127         serviceTypes = new HashMap<>();\r
 128         serviceEndpoints = new HashMap<>();\r
 129         regions = new HashSet<>();\r
 130         Class<?> connectorClass;\r
 131         OpenStackClientConnector connector;\r
 132         try {\r
 133             connectorClass = Class.forName(CLIENT_CONNECTOR_CLASS);\r
 134             connector = (OpenStackClientConnector) connectorClass.newInstance();\r
 135         } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {\r
 136             logger.error("An error occurred when initializing ServiceCatalogV3", e);\r
 137             return;\r
 138         }\r
 139         Keystone keystone = new Keystone(identityURL, connector);\r
 140 \r
 141         String proxyHost = properties.getProperty(ContextFactory.PROPERTY_PROXY_HOST);\r
 142         String proxyPort = properties.getProperty(ContextFactory.PROPERTY_PROXY_PORT);\r
 143         String trustedHosts = properties.getProperty(ContextFactory.PROPERTY_TRUSTED_HOSTS, ""); //$NON-NLS-1$\r
 144         if (proxyHost != null && proxyHost.length() > 0) {\r
 145             keystone.getProperties().setProperty(com.woorea.openstack.common.client.Constants.PROXY_HOST, proxyHost);\r
 146             keystone.getProperties().setProperty(com.woorea.openstack.common.client.Constants.PROXY_PORT, proxyPort);\r
 147         }\r
 148         if (trustedHosts != null) {\r
 149             keystone.getProperties().setProperty(com.woorea.openstack.common.client.Constants.TRUST_HOST_LIST,\r
 150                 trustedHosts);\r
 151         }\r
 152 \r
 153         // create identity\r
 154         Identity identity = Identity.password(domain, principal, credential);\r
 155 \r
 156         // create scope\r
 157         Scope scope = initScope();\r
 158 \r
 159         Authentication authentication = new Authentication();\r
 160         authentication.setIdentity(identity);\r
 161         authentication.setScope(scope);\r
 162 \r
 163         TokensResource tokens = keystone.tokens();\r
 164         TokensResource.Authenticate authenticate = tokens.authenticate(authentication);\r
 165 \r
 166         /*\r
 167          * We have to set up the TrackRequest TLS collection for the ExceptionMapper\r
 168          */\r
 169         trackRequest();\r
 170         RequestState.put(RequestState.PROVIDER, "OpenStackProvider");\r
 171         RequestState.put(RequestState.TENANT, projectIdentifier);\r
 172         RequestState.put(RequestState.PRINCIPAL, principal);\r
 173 \r
 174         try {\r
 175             token = authenticate.execute();\r
 176             // Ensure that token is not null before accessing\r
 177             // local expiration or the internal details of token\r
 178             if (token == null) {\r
 179                 throw new NullPointerException("Access token is null. Failed to init ServiceCatalogV3");\r
 180             }\r
 181             expiresLocal = getLocalExpiration(token);\r
 182             project = token.getProject();\r
 183             tokenProvider = new OpenStackSimpleTokenProvider(token.getId());\r
 184             keystone.setTokenProvider(tokenProvider);\r
 185             parseServiceCatalog(token.getCatalog());\r
 186         } catch (OpenStackBaseException e) {\r
 187             ExceptionMapper.mapException(e);\r
 188         } catch (Exception e) {\r
 189             throw new ContextConnectionException(e);\r
 190         }\r
 191     }\r
 192 \r
 193     private Scope initScope() {\r
 194         if (projectIdentifier.length() == 32 && projectIdentifier.matches("[0-9a-fA-F]+")) { //$NON-NLS-1$\r
 195             return Scope.project(projectIdentifier);\r
 196         } else {\r
 197             return Scope.project(domain, projectIdentifier);\r
 198         }\r
 199     }\r
 200 \r
 201     /**\r
 202      * {@inheritDoc}\r
 203      */\r
 204     @Override\r
 205     public List<Service.Endpoint> getEndpoints(String serviceType) {\r
 206         Lock readLock = rwLock.readLock();\r
 207         readLock.lock();\r
 208         try {\r
 209             return serviceEndpoints.get(serviceType);\r
 210         } finally {\r
 211             readLock.unlock();\r
 212         }\r
 213     }\r
 214 \r
 215     /**\r
 216      * {@inheritDoc}\r
 217      */\r
 218     @Override\r
 219     public String getProjectId() {\r
 220         Lock readLock = rwLock.readLock();\r
 221         readLock.lock();\r
 222         try {\r
 223             return project.getId();\r
 224         } finally {\r
 225             readLock.unlock();\r
 226         }\r
 227     }\r
 228 \r
 229     /**\r
 230      * {@inheritDoc}\r
 231      */\r
 232     @Override\r
 233     public String getProjectName() {\r
 234         return getProject().getName();\r
 235     }\r
 236 \r
 237     /**\r
 238      * {@inheritDoc}\r
 239      */\r
 240     @Override\r
 241     public Set<String> getRegions() {\r
 242         Lock readLock = rwLock.readLock();\r
 243         readLock.lock();\r
 244         try {\r
 245             return regions;\r
 246         } finally {\r
 247             readLock.unlock();\r
 248         }\r
 249     }\r
 250 \r
 251     /**\r
 252      * {@inheritDoc}\r
 253      */\r
 254     @Override\r
 255     public List<String> getServiceTypes() {\r
 256         Lock readLock = rwLock.readLock();\r
 257         readLock.lock();\r
 258         try {\r
 259             ArrayList<String> result = new ArrayList<>();\r
 260             result.addAll(serviceTypes.keySet());\r
 261             return result;\r
 262         } finally {\r
 263             readLock.unlock();\r
 264         }\r
 265     }\r
 266 \r
 267     /**\r
 268      * {@inheritDoc}\r
 269      */\r
 270     @Override\r
 271     public String getVMRegion(VMURL url) {\r
 272         String region = null;\r
 273         Pattern urlPattern = Pattern.compile("[^:]+://([^:/]+)(?::([0-9]+)).*");\r
 274 \r
 275         if (url != null) {\r
 276             for (Endpoint endpoint : getEndpoints(ServiceCatalog.COMPUTE_SERVICE)) {\r
 277                 String endpointUrl = endpoint.getUrl();\r
 278                 Matcher matcher = urlPattern.matcher(endpointUrl);\r
 279                 if (validateUrl(url, matcher)) {\r
 280                     region = endpoint.getRegion();\r
 281                     break;\r
 282                 }\r
 283             }\r
 284         }\r
 285         return region;\r
 286     }\r
 287 \r
 288     private boolean validateUrl(VMURL url, Matcher matcher) {\r
 289         return matcher.matches()\r
 290             && url.getHost().equals(matcher.group(1))\r
 291             && (url.getPort() == null || url.getPort().equals(matcher.group(2)));\r
 292     }\r
 293 \r
 294     /**\r
 295      * {@inheritDoc}\r
 296      */\r
 297     @Override\r
 298     public boolean isServicePublished(String serviceType) {\r
 299         Lock readLock = rwLock.readLock();\r
 300         readLock.lock();\r
 301         try {\r
 302             return serviceTypes.containsKey(serviceType);\r
 303         } finally {\r
 304             readLock.unlock();\r
 305         }\r
 306     }\r
 307 \r
 308     /**\r
 309      * {@inheritDoc}\r
 310      */\r
 311     @Override\r
 312     public String toString() {\r
 313 \r
 314         StringBuilder builder = new StringBuilder();\r
 315         Lock lock = rwLock.readLock();\r
 316         lock.lock();\r
 317         try {\r
 318             builder.append(String.format("Service Catalog: tenant %s, id[%s]%n", project.getName(), //$NON-NLS-1$\r
 319                 project.getId()));\r
 320             if (regions != null && !regions.isEmpty()) {\r
 321                 builder.append(String.format("%d regions:%n", regions.size())); //$NON-NLS-1$\r
 322                 for (String region : regions) {\r
 323                     //$NON-NLS-1$ //$NON-NLS-2$\r
 324                     builder\r
 325                         .append("\t")\r
 326                         .append(region)\r
 327                         .append("%n");\r
 328                 }\r
 329             }\r
 330             builder.append(String.format("%d services:%n", serviceEndpoints.size())); //$NON-NLS-1$\r
 331 \r
 332             for (Map.Entry<String, List<Service.Endpoint>> entry : serviceEndpoints.entrySet()) {\r
 333                 Service service = serviceTypes.get(entry.getKey());\r
 334 \r
 335                 builder.append(String.format("\t%s - %d endpoints%n", service.getType(), //$NON-NLS-1$\r
 336                     entry.getValue().size()));\r
 337 \r
 338                 for (Service.Endpoint endpoint : entry.getValue()) {\r
 339                     builder\r
 340                         .append(String.format("\t\tRegion [%s], public URL [%s]%n", endpoint.getRegion(), //$NON-NLS-1$\r
 341                             endpoint.getUrl()));\r
 342                 }\r
 343             }\r
 344         } finally {\r
 345             lock.unlock();\r
 346         }\r
 347 \r
 348         return builder.toString();\r
 349     }\r
 350 \r
 351     /**\r
 352      * Parses the service catalog and caches the results\r
 353      *\r
 354      * @param services The list of services published by this provider\r
 355      */\r
 356     private void parseServiceCatalog(List<Service> services) {\r
 357         Lock lock = rwLock.writeLock();\r
 358         lock.lock();\r
 359         try {\r
 360             serviceTypes.clear();\r
 361             serviceEndpoints.clear();\r
 362             regions.clear();\r
 363 \r
 364             for (Service service : services) {\r
 365                 String type = service.getType();\r
 366                 serviceTypes.put(type, service);\r
 367                 addRegions(service, type);\r
 368             }\r
 369         } finally {\r
 370             lock.unlock();\r
 371         }\r
 372     }\r
 373 \r
 374     private void addRegions(Service service, String type) {\r
 375         List<Endpoint> endpoints = service.getEndpoints();\r
 376         for (Endpoint endpoint : endpoints) {\r
 377             serviceEndpoints.computeIfAbsent(type, val -> new ArrayList<>());\r
 378             serviceEndpoints.get(type).add(endpoint);\r
 379 \r
 380             String region = endpoint.getRegion();\r
 381             if (!regions.contains(region)) {\r
 382                 regions.add(region);\r
 383             }\r
 384         }\r
 385     }\r
 386 \r
 387     /**\r
 388      * Computes the local time when the access token will expire, after which we will need to re-login to access the\r
 389      * provider.\r
 390      *\r
 391      * @param accessKey The access key used to access the provider\r
 392      * @return The local time the key expires\r
 393      */\r
 394     private static long getLocalExpiration(Token accessToken) {\r
 395         Date now = Time.getCurrentUTCDate();\r
 396         Calendar issued = accessToken.getIssuedAt();\r
 397         Calendar expires = accessToken.getExpiresAt();\r
 398         if (issued != null && expires != null) {\r
 399             long tokenLife = expires.getTimeInMillis() - issued.getTimeInMillis();\r
 400             return now.getTime() + tokenLife;\r
 401         }\r
 402         return now.getTime();\r
 403     }\r
 404     \r
 405     public Project getProject() {\r
 406         Lock readLock = rwLock.readLock();\r
 407         readLock.lock();\r
 408         try {\r
 409             return project;\r
 410         } finally {\r
 411             readLock.unlock();\r
 412         }\r
 413     }\r
 414 }