Skip to content

Commit

Permalink
Add logging
Browse files Browse the repository at this point in the history
  • Loading branch information
@zbynek
zbynek committed Feb 5, 2020
1 parent 0fe6d56 commit 7535b70
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 34 deletions.
18 changes: 8 additions & 10 deletions src/main/java/org/jenkinsci/pipeline_steps_doc_generator/HyperLocalPluginManger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
* Acts as a PluginManager that operates outside the normal startup process of Jenkins. Essentially, this captures the
Expand All @@ -44,6 +45,7 @@
* use calls to Jenkins.
*/
public class HyperLocalPluginManger extends LocalPluginManager{
private static final Logger LOG = Logger.getLogger(HyperLocalPluginManger.class.getName());
private final ModClassicPluginStrategy strategy;
public final UberPlusClassLoader uberPlusClassLoader = new UberPlusClassLoader();
private final boolean checkCycles;
Expand Down Expand Up @@ -126,7 +128,7 @@ public void run(Reactor session1) throws Exception {
private boolean isDuplicate(PluginWrapper p) {
String shortName = p.getShortName();
if (inspectedShortNames.containsKey(shortName)) {
System.out.println("Ignoring "+arc+" because "+inspectedShortNames.get(shortName)+" is already loaded");
LOG.info("Ignoring "+arc+" because "+inspectedShortNames.get(shortName)+" is already loaded");
return true;
}

Expand Down Expand Up @@ -164,7 +166,7 @@ private void addTo(List<PluginWrapper.Dependency> dependencies, List<PluginWrapp
protected void reactOnCycle(PluginWrapper q, List<PluginWrapper> cycle)
throws hudson.util.CyclicGraphDetector.CycleDetectedException {

System.out.println("FATAL: found cycle in plugin dependencies: (root="+q+", deactivating all involved) "+Util.join(cycle," -> "));
LOG.severe("FATAL: found cycle in plugin dependencies: (root="+q+", deactivating all involved) "+Util.join(cycle," -> "));
for (PluginWrapper pluginWrapper : cycle) {
pluginWrapper.setHasCycleDependency(true);
failedPlugins.add(new FailedPlugin(pluginWrapper.getShortName(), new CycleDetectedException(cycle)));
Expand Down Expand Up @@ -465,7 +467,7 @@ private <T> Collection<ExtensionComponent<T>> _find(Class<T> type, List<IndexIte
} catch (LinkageError|Exception e) {
// sometimes the instantiation fails in an indirect classloading failure,
// which results in a LinkageError
System.out.println("Failed to load "+item.className() + "\n" + e);
LOG.fine("Failed to load "+item.className() + "\n" + e);
}
}

Expand All @@ -490,14 +492,10 @@ public void scout(Class extensionType, ClassLoader cl) {
// according to JDK-4993813 this is the only way to force class initialization
Class.forName(extType.getName(),true,extType.getClassLoader());
} catch (Exception | LinkageError e) {
System.out.println("Failed to scout " + item.className() + "\n" + e);
LOG.fine("Failed to scout " + item.className() + "\n" + e);
}
}
}

private Level logLevel(IndexItem<Extension, Object> item) {
return item.annotation().optional() ? Level.FINE : Level.WARNING;
}
}

/**
Expand All @@ -510,11 +508,11 @@ protected String getPluginNameForDescriptor(Descriptor<?> d) {
try {
uberPlusClassLoader.findClass(className);
} catch (ClassNotFoundException e) {
e.printStackTrace();
LOG.log(Level.WARNING, "Class not found", e);
}
String pluginName = uberPlusClassLoader.getByPlugin().get(className);
if (pluginName == null) {
System.out.println("No plugin found, assuming core: " + className);
LOG.info("No plugin found, assuming core: " + className);
return "core";
}
return pluginName.trim();
Expand Down
40 changes: 24 additions & 16 deletions src/main/java/org/jenkinsci/pipeline_steps_doc_generator/PipelineStepExtractor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,13 @@

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.io.StringReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
Expand All @@ -46,6 +50,11 @@
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Predicate;
import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
import java.util.logging.LogManager;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;
import java.util.stream.Stream;

import static org.mockito.Mockito.*;
Expand All @@ -54,6 +63,10 @@
* Process and find all the Pipeline steps definied in Jenkins plugins.
*/
public class PipelineStepExtractor {
private static final Logger LOG = Logger.getLogger(PipelineStepExtractor.class.getName());
static {
System.setProperty("java.util.logging.SimpleFormatter.format","[%4$-7s] %5$s %6$s%n");
}
@Option(name="-homeDir",usage="Root directory of the plugin folder. This serves as the root directory of the PluginManager.")
public String homeDir = null;

Expand All @@ -69,18 +82,16 @@ public static void main(String[] args){
CmdLineParser p = new CmdLineParser(pse);
p.parseArgument(args);
} catch(Exception ex){
ex.printStackTrace();
System.out.println("There was an error with parsing the commands, defaulting to the home directory.");
LOG.log(Level.SEVERE, "There was an error with parsing the commands, defaulting to the home directory.", ex);
}
try{
Map<String, Map<String, List<QuasiDescriptor>>> steps = pse.findSteps();
pse.generateAscii(steps, pse.pluginManager);
pse.generateDeclarativeAscii();
} catch(Exception ex){
ex.printStackTrace();
System.out.println("Error in finding all the steps");
LOG.log(Level.SEVERE, "Error in finding all the steps", ex);
}
System.out.println("CONVERSION COMPLETE!");
LOG.info("CONVERSION COMPLETE!");
System.exit(0); //otherwise environment hangs around
}

Expand Down Expand Up @@ -128,8 +139,7 @@ public Map<String, Map<String, List<QuasiDescriptor>>> findSteps(){
completeListing.put(opt, exists);
}
} catch (Exception ex){
ex.printStackTrace();
//log exception, job essentially fails
LOG.log(Level.SEVERE, "Step generation failed", ex);
}

return completeListing;
Expand Down Expand Up @@ -206,7 +216,7 @@ protected void runTask(Task task) throws Exception {
new InitReactorRunner() {
@Override
protected void onInitMilestoneAttained(InitMilestone milestone) {
System.out.println("init milestone attained " + milestone);
LOG.info("init milestone attained " + milestone);
}
}.run(reactor);
}
Expand Down Expand Up @@ -239,7 +249,7 @@ public void generateAscii(Map<String, Map<String, List<QuasiDescriptor>>> allSte
allAscii.mkdirs();
String allAsciiPath = allAscii.getAbsolutePath();
for(String plugin : allSteps.keySet()){
System.out.println("processing " + plugin);
LOG.info("processing " + plugin);
Map<String, List<QuasiDescriptor>> byPlugin = allSteps.get(plugin);
PluginWrapper thePlugin = pluginManager.getPlugin(plugin);
String displayName = thePlugin == null ? "Jenkins Core" : thePlugin.getDisplayName();
Expand All @@ -248,8 +258,7 @@ public void generateAscii(Map<String, Map<String, List<QuasiDescriptor>>> allSte
try {
FileUtils.writeStringToFile(new File(allAsciiPath, plugin + ".adoc"), whole9yards, StandardCharsets.UTF_8);
} catch (Exception ex){
ex.printStackTrace();
System.out.println("Error generating plugin file for " + plugin + ". Skip.");
LOG.log(Level.SEVERE, "Error generating plugin file for " + plugin + ". Skip.", ex);
//continue to next plugin
}
}
Expand All @@ -268,22 +277,21 @@ public void generateDeclarativeAscii() {
Map<Class<? extends Descriptor>, Predicate<Descriptor>> filters = getDeclarativeFilters();

for (Map.Entry<String,List<Class<? extends Descriptor>>> entry : getDeclarativeDirectives().entrySet()) {
System.out.println("Generating docs for directive " + entry.getKey());
LOG.info("Generating docs for directive " + entry.getKey());
Map<String, List<Descriptor>> pluginDescMap = new HashMap<>();

for (Class<? extends Descriptor> d : entry.getValue()) {
Predicate<Descriptor> filter = filters.get(d);
System.out.println(" - Loading descriptors of type " + d.getSimpleName() + " with filter: " + (filter != null));
LOG.info(" - Loading descriptors of type " + d.getSimpleName() + " with filter: " + (filter != null));
pluginDescMap = processDescriptors(d, pluginDescMap, filter);
}

String whole9yards = ToAsciiDoc.generateDirectiveHelp(entry.getKey(), pluginDescMap, true);

try{
FileUtils.writeStringToFile(new File(declPath, entry.getKey() + ".adoc"), whole9yards, StandardCharsets.UTF_8);
} catch (Exception ex){
ex.printStackTrace();
System.out.println("Error generating directive file for " + entry.getKey() + ". Skip.");
} catch (Exception ex) {
LOG.log(Level.SEVERE, "Error generating directive file for " + entry.getKey() + ". Skip.", ex);
//continue to next directive
}
}
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/org/jenkinsci/pipeline_steps_doc_generator/ToAsciiDoc.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,15 @@
import java.util.Optional;
import java.util.Set;
import java.util.Stack;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;

//fake out unit tests
import hudson.Main;

public class ToAsciiDoc {
private static final Logger LOG = Logger.getLogger(ToAsciiDoc.class.getName());
/**
* Keeps track of nested {@link DescribableModel#getType()} to avoid recursion.
*/
Expand Down Expand Up @@ -81,6 +84,7 @@ private static String describeType(ParameterType type) throws Exception {
}
} else if (type instanceof ErrorType) { //Shouldn't hit this; open a ticket
Exception x = ((ErrorType) type).getError();
LOG.log(Level.FINE, "Encountered ErrorType object with exception:" + x);
if(x instanceof NoStaplerConstructorException || x instanceof UnsupportedOperationException) {
String msg = x.toString();
typeInfo.append("<code>").append(msg.substring(msg.lastIndexOf(" ")).trim()).append("</code>\n");
Expand Down Expand Up @@ -164,7 +168,7 @@ public static String generateStepHelp(QuasiDescriptor d){
}
} catch (Exception | Error ex) {
mkDesc.append("<code>").append(ex).append("</code>");
System.out.println("Description of " + d.real.clazz + " skipped, encountered " + ex);
LOG.log(Level.SEVERE, "Description of " + d.real.clazz + " skipped, encountered ", ex);
}
return mkDesc.append("\n\n\n++++\n").toString();
}
Expand All @@ -174,7 +178,7 @@ private static void appendSimpleStepDescription(StringBuilder mkDesc, Class<?> c
mkDesc.append(generateHelp(new DescribableModel<>(clazz), true));
} catch (Exception ex) {
mkDesc.append(getHelp("help.html", clazz));
System.out.println("Description of " + clazz + " restricted, encountered " + ex);
LOG.log(Level.WARNING, "Description of " + clazz + " restricted, encountered ", ex);
}
}

Expand Down Expand Up @@ -207,14 +211,10 @@ private static String generateDescribableHelp(Descriptor<?> d) {
StringBuilder mkDesc = new StringBuilder(header(3)).append(" `").append(symbols.iterator().next()).append("`: ").append(d.getDisplayName()).append("\n");
try {
mkDesc.append(generateHelp(new DescribableModel<>(d.clazz), true)).append("\n\n");
} catch (Exception ex) {
ex.printStackTrace();
} catch (Exception | Error ex) {
LOG.log(Level.SEVERE, "Problem generating help for descriptor", ex);
// backtick-plus for safety - monospace literal string
mkDesc.append("`+").append(ex).append("+`\n\n");
} catch (Error err) {
err.printStackTrace();
// backtick-plus for safety - monospace literal string
mkDesc.append("`+").append(err).append("+`\n\n");
}
return mkDesc.toString();
} else {
Expand Down

0 comments on commit 7535b70

Please sign in to comment.