co.cask.cdap.etl.tool.config.ClientUpgradeContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdap-etl-tools Show documentation
The newest version!
/*
 * Copyright © 2016 Cask Data, Inc.
 *
 * 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.
 */

package co.cask.cdap.etl.tool.config;

import co.cask.cdap.api.artifact.ArtifactScope;
import co.cask.cdap.api.artifact.ArtifactSummary;
import co.cask.cdap.client.ArtifactClient;
import co.cask.cdap.client.NamespaceClient;
import co.cask.cdap.etl.proto.ArtifactSelectorConfig;
import co.cask.cdap.etl.proto.UpgradeContext;
import co.cask.cdap.proto.NamespaceMeta;
import co.cask.cdap.proto.artifact.PluginInfo;
import co.cask.cdap.proto.id.ArtifactId;
import co.cask.cdap.proto.id.NamespaceId;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;
import javax.annotation.Nullable;

/**
 * Uses an ArtifactClient to get the artifact for a specific plugin.
 */
public class ClientUpgradeContext implements UpgradeContext {
  private static final Logger LOG = LoggerFactory.getLogger(ClientUpgradeContext.class);
  private final NamespaceClient namespaceClient;
  private final ArtifactClient artifactClient;
  private final String artifactName;
  private final String artifactVersion;
  private ArtifactId artifactId;

  public ClientUpgradeContext(NamespaceClient namespaceClient, ArtifactClient artifactClient, String artifactName,
                              String artifactVersion) {
    this.namespaceClient = namespaceClient;
    this.artifactClient = artifactClient;
    this.artifactName = artifactName;
    this.artifactVersion = artifactVersion;
  }

  @Nullable
  @Override
  public ArtifactSelectorConfig getPluginArtifact(String pluginType, String pluginName) {
    try {
      List plugins =
        artifactClient.getPluginInfo(getArtifactId(), pluginType, pluginName, ArtifactScope.SYSTEM);

      if (plugins.isEmpty()) {
        return null;
      }

      // doesn't really matter which one we choose, as all of them should be valid.
      // choosing the last one because that tends to be the one with the highest version.
      // order is not guaranteed though.
      ArtifactSummary chosenArtifact = plugins.get(plugins.size() - 1).getArtifact();
      return new ArtifactSelectorConfig(chosenArtifact.getScope().name(),
                                        chosenArtifact.getName(),
                                        chosenArtifact.getVersion());
    } catch (Exception e) {
      LOG.warn("Unable to find an artifact for plugin of type {} and name {}. " +
                 "Plugin artifact section will be left empty.", pluginType, pluginName);
      return null;
    }
  }

  private ArtifactId getArtifactId() {
    if (artifactId == null) {
      // just need to get a namespace that exists, ArtifactScope.SYSTEM will take care of the rest.
      NamespaceId namespaceId = NamespaceId.DEFAULT;
      try {
        List namespaces = namespaceClient.list();
        if (!namespaces.isEmpty()) {
          namespaceId = namespaceClient.list().get(0).getNamespaceId();
        }
      } catch (Exception e) {
        LOG.warn("Unable to list namespaces. Plugin artifact sections will likely be left empty.", e);
      }
      artifactId = namespaceId.artifact(artifactName, artifactVersion);
    }
    return artifactId;
  }
}