com.ibm.ta.sdk.sample.SamplePluginProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ta-sdk-sample Show documentation
a tool to help a developer to create and build a middleware data collection plug-in, \ which can be used to gather the information of an application deployed on a middleware server,\ and provide modernization help and recommendations
There is a newer version: 1.0.3
Show newest version
/*
 * (C) Copyright IBM Corp. 2019,2020
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.ta.sdk.sample;

import com.ibm.ta.sdk.spi.collect.EnvironmentJson;
import com.ibm.ta.sdk.spi.plugin.CliInputCommand;
import com.ibm.ta.sdk.spi.plugin.CliInputOption;
import com.ibm.ta.sdk.spi.plugin.TAException;
import com.ibm.ta.sdk.core.plugin.GenericPluginProvider;
import com.ibm.ta.sdk.core.collect.GenericAssessmentUnit;
import com.ibm.ta.sdk.core.collect.GenericDataCollection;
import com.ibm.ta.sdk.spi.collect.DataCollection;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import org.tinylog.Logger;

import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class SamplePluginProvider extends GenericPluginProvider {
  private static final String SAMPLE_DOMAIN = "domain";
  private static final String SAMPLE_MIDDLEWARE= "middleware";

  // use the middleware specific technology to detect all the collection units and assessment units for one collection
  // in this sample we just use this Map to simulate the collection and assessment units discovered by the plug-in
  private static Map predefinedCollectionSets = Stream.of(new Object[][] {
    { "collection1", Arrays.asList("assessmentUnit1") },
    { "collection2", Arrays.asList("assessmentUnit2", "assessmentUnit3") }
  }).collect(Collectors.toMap(data -> (String) data[0], data -> (List) data[1]));

  // JSON files
  private static final String FILE_ASSESS_DATA_DIR = "/sampleData/";
  private static final String FILE_ASSESS_CONFIG_FILE_JSON = "/sampleData/SampleConfigFile.json";
  private static final String FILE_ASSESS_CONFIG_FILE2_JSON = "/sampleData/SampleConfigFile2.json";
  private static final String FILE_ASSESS_CONFIG_FILE_XML= "/sampleData/sampleData.xml";
  private static final String FILE_ASSESS_CONFIG_FILE_XML2= "/sampleData/server.xml";

  @Override
  public String getDomain() {
    return SAMPLE_DOMAIN;
  }

  @Override
  public String getMiddleware() {
    return SAMPLE_MIDDLEWARE;
  }

  @Override
  public CliInputCommand getCollectCommand() {
    // Collect command
    CliInputOption collectCmdCollectionOpt = new CliInputOption("c", "collectionUnit", "The name of the collection unit to perform the collection", true, false, null, null);
    CliInputOption collectCmdAssessmentOpt = new CliInputOption("a", "assessmentUnit", "The name of the assessment unit", true, true, null, null);
    List collectionCmdOpts = Arrays.asList(collectCmdCollectionOpt, collectCmdAssessmentOpt);
    CliInputCommand collectCmd = new CliInputCommand(CliInputCommand.CMD_COLLECT,
            "Performs data collection",
            collectionCmdOpts, null, Arrays.asList("INSTALL_PATH"));
    return collectCmd;
  }

  @Override
  public List getCollection(CliInputCommand cliInputCommand) throws TAException {
    Logger.info("CliInputCommandOptions:" + cliInputCommand.getOptions());
    Logger.info("CliInputCommandArguments:" + cliInputCommand.getArguments());

    List collectionUnitOptionValues = CliInputOption.getCliOptionValuesByShortName(cliInputCommand.getOptions(), "c");
    List assessmentUnitOptionValues = CliInputOption.getCliOptionValuesByShortName(cliInputCommand.getOptions(), "a");
    Logger.debug("pass in option values for collection unit names:" + collectionUnitOptionValues);
    Logger.debug("pass in option values for assessment unit names:" + assessmentUnitOptionValues);
    try {
      List collections = new ArrayList<>();
      for (Object collectionUnit: predefinedCollectionSets.keySet()) {
        String collectionName = (String)collectionUnit;
        if (collectionUnitOptionValues==null || collectionUnitOptionValues.size()==0 || collectionUnitOptionValues.contains(collectionName) ) {
          DataCollection oneCollection = getDataCollection(cliInputCommand.getArguments().get(0), collectionName, assessmentUnitOptionValues);
          collections.add(oneCollection);
        } else {
          Logger.warn("collection unit " + collectionName + " is not included in the pass in options, skip it");
        }
      }
      return collections;
    } catch (URISyntaxException e) {
      throw new TAException(e);
    } catch (IOException e) {
      throw new TAException(e);
    }
  }

  private DataCollection getDataCollection(String installPath, String collectionUnitName, List userDefinedAssessmentUnits) throws IOException, URISyntaxException {
      // put your logic here to detect the middleware runtime environment and construct the environmentJson object
      EnvironmentJson envJson = new EnvironmentJson(SAMPLE_DOMAIN, SAMPLE_MIDDLEWARE, "1.0.0");
      envJson.setMiddlewareInstallPath(installPath);
      envJson.setMiddlewareDataPath("/opt/instance/configPath");
      envJson.setCollectionUnitName(collectionUnitName);
      envJson.setCollectionUnitType("instance");
      envJson.setHasSensitiveData(false);


      List auList = new ArrayList<>();
      for (String assessmentName: (List)predefinedCollectionSets.get(collectionUnitName)) {
        if (userDefinedAssessmentUnits==null || userDefinedAssessmentUnits.size()==0 || userDefinedAssessmentUnits.contains(assessmentName) ) {
          auList.add(getAssessmentUnit(assessmentName));
        } else {
          Logger.warn("assessment unit " + assessmentName + " is not included in the pass in options, skip it");
        }
      }
      return new GenericDataCollection(collectionUnitName, envJson, auList);
  }

  private GenericAssessmentUnit getAssessmentUnit(String assessmentUnitName) throws URISyntaxException, IOException {
    // use the middleware specific technology to generate the assesment unit data json file
    // in this sample plug-in we assume the /sampleData/assessmentUnit1.json is the generated file
    Path assessDataJsonFile = Paths.get(SamplePluginProvider.class.getResource(FILE_ASSESS_DATA_DIR+assessmentUnitName+".json").toURI());
    List assessmentConfigFiles = new ArrayList();

    if (assessmentUnitName.equals("assessmentUnit1")) {
      // You can add more middlewware specific configuration files here.
      Path assessConfigJsonFile = Paths.get(SamplePluginProvider.class.getResource(FILE_ASSESS_CONFIG_FILE_JSON).toURI());
      Path assessConfigJsonFile2 = Paths.get(SamplePluginProvider.class.getResource(FILE_ASSESS_CONFIG_FILE2_JSON).toURI());
      Path assessConfigXmlFile = Paths.get(SamplePluginProvider.class.getResource(FILE_ASSESS_CONFIG_FILE_XML).toURI());
      Path assessConfigXmlFile2 = Paths.get(SamplePluginProvider.class.getResource(FILE_ASSESS_CONFIG_FILE_XML2).toURI());

      assessmentConfigFiles.add(assessConfigJsonFile);
      assessmentConfigFiles.add(assessConfigJsonFile2);
      assessmentConfigFiles.add(assessConfigXmlFile);
      assessmentConfigFiles.add(assessConfigXmlFile2);

      // here is the example to add a specific file on file system to the config file list
      File assessConfigXmlFile3 = new File("/tmp/sample/sampleConfig/sampleConfigFile.json");
      if (assessConfigXmlFile3.exists()) {
        assessmentConfigFiles.add(assessConfigXmlFile3.toPath());
      }
    }

    return super.getAssessmentUnit(assessmentUnitName, assessDataJsonFile, assessmentConfigFiles);
  }

  @Override
  public CliInputCommand getAssessCommand() {
    CliInputCommand assessCmd = super.getAssessCommand();
    List cmdOptions = assessCmd.getOptions();
    //CliInputOption targetOp = null;
    for (CliInputOption oneOption : cmdOptions) {
      if (oneOption.getLongArg().equals(CliInputOption.OPT_TARGET)) {
        // modify the description for default target option
        oneOption.setValueDisplayName("");
        oneOption.setDescription("Possible value is 'targetA' or 'targetB'");
        //targetOp = oneOption;
      }
    }
    //cmdOptions.remove(targetOp);
    return assessCmd;
  }
}