Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jmeterplugins.repository.PluginManager Maven / Gradle / Ivy
package org.jmeterplugins.repository;
import net.sf.json.JSON;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import net.sf.json.JSONSerializer;
import org.apache.jmeter.assertions.Assertion;
import org.apache.jmeter.config.ConfigElement;
import org.apache.jmeter.control.Controller;
import org.apache.jmeter.engine.JMeterEngine;
import org.apache.jmeter.gui.JMeterGUIComponent;
import org.apache.jmeter.processor.PostProcessor;
import org.apache.jmeter.processor.PreProcessor;
import org.apache.jmeter.samplers.SampleListener;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.testbeans.TestBean;
import org.apache.jmeter.timers.Timer;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.reflect.ClassFinder;
import org.apache.log.Logger;
import org.jmeterplugins.repository.exception.DownloadException;
import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.file.AccessDeniedException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
public class PluginManager {
private static final Logger log = LoggingManager.getLoggerForClass();
private static PluginManager staticManager = new PluginManager();
private final JARSource jarSource;
protected Map allPlugins = new HashMap<>();
public PluginManager() {
String sysProp = System.getProperty("jpgc.repo.address", "https://jmeter-plugins.org/repo/");
String jmProp = JMeterUtils.getPropDefault("jpgc.repo.address", sysProp);
File jsonFile = new File(jmProp);
if (jsonFile.isFile()) {
jarSource = new JARSourceFilesystem(jsonFile);
} else {
jarSource = new JARSourceHTTP(jmProp);
}
}
public boolean hasPlugins() {
return allPlugins.size() > 0;
}
public synchronized void load() throws Throwable {
detectJARConflicts();
if (hasPlugins()) {
return;
}
JSON json = jarSource.getRepo();
if (!(json instanceof JSONArray)) {
throw new RuntimeException("Result is not array");
}
for (Object elm : (JSONArray) json) {
if (elm instanceof JSONObject) {
Plugin plugin = Plugin.fromJSON((JSONObject) elm);
if (plugin.getName().isEmpty()) {
log.debug("Skip empty name: " + plugin);
continue;
}
if (!plugin.isVirtual()) {
plugin.detectInstalled(getInstalledPlugins());
}
allPlugins.put(plugin, plugin.isInstalled());
} else {
log.warn("Invalid array element: " + elm);
}
}
// after all usual plugins detected, detect virtual sets
for (Plugin plugin : allPlugins.keySet()) {
if (plugin.isVirtual()) {
plugin.detectInstalled(getInstalledPlugins());
allPlugins.put(plugin, plugin.isInstalled());
}
}
if (JMeterUtils.getPropDefault("jpgc.repo.sendstats", "true").equals("true")) {
try {
jarSource.reportStats(getUsageStats());
} catch (Exception e) {
log.debug("Failed to report usage stats", e);
}
}
log.info("Plugins Status: " + getAllPluginsStatusString());
}
private void checkRW() throws UnsupportedEncodingException, AccessDeniedException {
String jarPath = Plugin.getJARPath(JMeterEngine.class.getCanonicalName());
if (jarPath != null) {
File libext = new File(URLDecoder.decode(jarPath, "UTF-8")).getParentFile();
if (!isWritable(libext)) {
String msg = "Have no write access for JMeter directories, not possible to use Plugins Manager: ";
throw new AccessDeniedException(msg + libext);
}
}
}
private boolean isWritable(File path) {
File sample = new File(path, "empty.txt");
try {
sample.createNewFile();
sample.delete();
return true;
} catch (IOException e) {
log.debug("Write check failed for " + path, e);
return false;
}
}
public void startModifications(Set delPlugins, Set installPlugins, Map installLibs,
Set libDeletions, boolean doRestart, LinkedList additionalJMeterOptions) throws IOException {
ChangesMaker maker = new ChangesMaker(allPlugins);
File moveFile = maker.getMovementsFile(delPlugins, installPlugins, installLibs, libDeletions);
File installFile = maker.getInstallFile(installPlugins);
File restartFile;
if (doRestart) {
restartFile = maker.getRestartFile(additionalJMeterOptions);
} else {
restartFile = null;
}
final ProcessBuilder builder = maker.getProcessBuilder(moveFile, installFile, restartFile);
log.info("JAR Modifications log will be saved into: " + builder.redirectOutput().file().getPath());
builder.start();
}
public void applyChanges(GenericCallback statusChanged, boolean doRestart, LinkedList additionalJMeterOptions) {
try {
checkRW();
} catch (Throwable e) {
throw new RuntimeException("Cannot apply changes: " + e.getMessage(), e);
}
DependencyResolver resolver = new DependencyResolver(allPlugins);
Set additions = resolver.getAdditions();
Map libInstalls = new HashMap<>();
for (Map.Entry entry : resolver.getLibAdditions().entrySet()) {
try {
JARSource.DownloadResult dwn = jarSource.getJAR(entry.getKey(), entry.getValue(), statusChanged);
libInstalls.put(dwn.getTmpFile(), dwn.getFilename());
} catch (Throwable e) {
String msg = "Failed to download " + entry.getKey();
log.error(msg, e);
statusChanged.notify(msg);
throw new DownloadException("Failed to download library " + entry.getKey(), e);
}
}
for (Plugin plugin : additions) {
try {
plugin.download(jarSource, statusChanged);
} catch (IOException e) {
String msg = "Failed to download " + plugin;
log.error(msg, e);
statusChanged.notify(msg);
throw new DownloadException("Failed to download plugin " + plugin, e);
}
}
log.info("Restarting JMeter...");
statusChanged.notify("Restarting JMeter...");
Set libDeletions = new HashSet<>();
for (String lib : resolver.getLibDeletions()) {
libDeletions.add(Plugin.getLibInstallPath(lib));
}
modifierHook(resolver.getDeletions(), additions, libInstalls, libDeletions, doRestart, additionalJMeterOptions);
}
private void modifierHook(final Set deletions, final Set additions, final Map libInstalls,
final Set libDeletions, final boolean doRestart, final LinkedList additionalJMeterOptions) {
Runtime.getRuntime().addShutdownHook(new Thread() {
@Override
public void run() {
try {
log.info("Starting JMeter Plugins modifications");
startModifications(deletions, additions, libInstalls, libDeletions, doRestart, additionalJMeterOptions);
} catch (Exception e) {
log.warn("Failed to run plugin cleaner job", e);
}
}
});
}
protected String[] getUsageStats() {
ArrayList data = new ArrayList<>();
data.add(JMeterUtils.getJMeterVersion());
for (Plugin p : getInstalledPlugins()) {
data.add(p.getID() + "=" + p.getInstalledVersion());
}
log.debug("Usage stats: " + data);
return data.toArray(new String[0]);
}
public String getChangesAsText() {
DependencyResolver resolver = new DependencyResolver(allPlugins);
StringBuilder text = new StringBuilder();
for (Plugin pl : resolver.getDeletions()) {
text.append("Uninstall plugin: ").append(pl).append(" ").append(pl.getInstalledVersion()).append("\n");
}
for (String pl : resolver.getLibDeletions()) {
text.append("Uninstall library: ").append(pl).append("\n");
}
for (String pl : resolver.getLibAdditions().keySet()) {
text.append("Install library: ").append(pl).append("\n");
}
for (Plugin pl : resolver.getAdditions()) {
text.append("Install plugin: ").append(pl).append(" ").append(pl.getCandidateVersion()).append("\n");
}
return text.toString();
}
public Set getInstalledPlugins() {
Set result = new TreeSet<>(new PluginComparator());
for (Plugin plugin : allPlugins.keySet()) {
if (plugin.isInstalled()) {
result.add(plugin);
}
}
return result;
}
public static Set getInstalledPlugins(Map allPlugins) {
Set result = new HashSet<>();
for (Plugin plugin : allPlugins.keySet()) {
if (plugin.isInstalled()) {
result.add(plugin);
}
}
return result;
}
public Set getAvailablePlugins() {
Set result = new TreeSet<>(new PluginComparator());
for (Plugin plugin : allPlugins.keySet()) {
if (!plugin.isInstalled()) {
result.add(plugin);
}
}
return result;
}
public Set getUpgradablePlugins() {
Set result = new TreeSet<>(new PluginComparator());
for (Plugin plugin : allPlugins.keySet()) {
if (plugin.isUpgradable()) {
result.add(plugin);
}
}
return result;
}
public void togglePlugins(Set pluginsToInstall, boolean isInstall) {
for (Plugin plugin : pluginsToInstall) {
toggleInstalled(plugin, isInstall);
}
}
public void toggleInstalled(Plugin plugin, boolean cbState) {
if (!cbState && !plugin.canUninstall()) {
log.warn("Cannot uninstall plugin: " + plugin);
cbState = true;
}
allPlugins.put(plugin, cbState);
}
public boolean hasAnyUpdates() {
for (Plugin p : allPlugins.keySet()) {
if (p.isUpgradable()) {
return true;
}
}
return false;
}
public Plugin getPluginByID(String key) {
for (Plugin p : allPlugins.keySet()) {
if (p.getID().equals(key)) {
return p;
}
}
throw new IllegalArgumentException("Plugin not found in repo: " + key);
}
private class PluginComparator implements java.util.Comparator {
@Override
public int compare(Plugin o1, Plugin o2) {
return o1.getName().compareTo(o2.getName());
}
}
public void setTimeout(int timeout) {
jarSource.setTimeout(timeout);
}
/**
* @return Static instance of manager, used to spare resources on repo loading
*/
public static PluginManager getStaticManager() {
try {
staticManager.load();
} catch (Throwable e) {
throw new RuntimeException("Failed to get plugin repositories", e);
}
return staticManager;
}
/**
* @param id ID of the plugin to check
* @return Version name for the plugin if it is installed, null otherwise
*/
public static String getPluginStatus(String id) {
PluginManager manager = getStaticManager();
for (Plugin plugin : manager.allPlugins.keySet()) {
if (plugin.id.equals(id)) {
return plugin.getInstalledVersion();
}
}
return null;
}
/**
* @return Status for all plugins
*/
public static String getAllPluginsStatus() {
PluginManager manager = getStaticManager();
return manager.getAllPluginsStatusString();
}
private String getAllPluginsStatusString() {
ArrayList res = new ArrayList<>();
for (Plugin plugin : getInstalledPlugins()) {
res.add(plugin.getID() + "=" + plugin.getInstalledVersion());
}
return Arrays.toString(res.toArray());
}
/**
* @return Available plugins
*/
public static String getAvailablePluginsAsString() {
PluginManager manager = getStaticManager();
return manager.getAvailablePluginsString();
}
private String getAvailablePluginsString() {
ArrayList res = new ArrayList<>();
for (Plugin plugin : getAvailablePlugins()) {
List versions = new ArrayList<>(plugin.getVersions());
Collections.reverse(versions);
res.add(plugin.getID() + "=" + Arrays.toString(versions.toArray()));
}
return Arrays.toString(res.toArray());
}
/**
* @return Upgradable plugins
*/
public static String getUpgradablePluginsAsString() {
PluginManager manager = getStaticManager();
return manager.getUpgradablePluginsString();
}
private String getUpgradablePluginsString() {
ArrayList res = new ArrayList<>();
for (Plugin plugin : getUpgradablePlugins()) {
res.add(plugin.getID() + "=" + plugin.getMaxVersion());
}
return (res.size() != 0) ?
Arrays.toString(res.toArray()) :
"There is nothing to update.";
}
public static void detectJARConflicts() {
String[] paths = System.getProperty("java.class.path").split(File.pathSeparator);
final Map jarNames = new HashMap<>();
for (String path : paths) {
String name = path;
int start = path.lastIndexOf(File.separator);
if (start > 0) {
name = name.substring(start + 1);
}
if (path.endsWith(".jar")) {
name = name.substring(0, name.length() - 4);
}
name = removeJARVersion(name);
if (jarNames.containsKey(name)) {
log.warn("Found JAR conflict: " + path + " and " + jarNames.get(name));
}
jarNames.put(name, path);
}
}
protected static String removeJARVersion(String path) {
StringBuilder result = new StringBuilder();
String data[] = path.split("-");
for (int i = 0; i < data.length; i++) {
String ch = data[i];
if (!ch.isEmpty() && (!Character.isDigit(ch.charAt(0)) || (i < data.length - 1))) {
result.append(ch);
}
}
return result.toString();
}
public void logPluginComponents() {
StringBuilder report = new StringBuilder("Plugin Components:\n");
for (Plugin plugin : getInstalledPlugins()) {
try {
Class[] superClasses = {
Sampler.class,
Controller.class,
Timer.class,
ConfigElement.class,
PreProcessor.class,
PostProcessor.class,
Assertion.class,
SampleListener.class,
JMeterGUIComponent.class,
TestBean.class
};
String[] searchPaths = {plugin.installedPath};
List list = ClassFinder.findClassesThatExtend(searchPaths, superClasses);
report.append(plugin.id).append("\n").append("\"componentClasses\":").append(JSONSerializer.toJSON(list.toArray()).toString()).append(",\n");
} catch (Throwable e) {
log.error("Failed to get classes", e);
}
}
log.info(report.toString());
}
}
