Skip to content

Commit

Permalink
Rationalize logging subsystem
Browse files Browse the repository at this point in the history
  • Loading branch information
@basil
basil committed Jan 14, 2023
1 parent 9abc651 commit b334867
Show file tree
Hide file tree
Showing 20 changed files with 241 additions and 167 deletions.
13 changes: 0 additions & 13 deletions logback.xml
View file

This file was deleted.

42 changes: 24 additions & 18 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
<properties>
<changelist>999999-SNAPSHOT</changelist>
<gitHubRepo>jenkinsci/plugin-compat-tester</gitHubRepo>
<logbackVersion>1.4.5</logbackVersion>
<maven.scm.providers.version>1.6</maven.scm.providers.version>
<slf4j.version>2.0.6</slf4j.version>
<spotbugs.effort>Max</spotbugs.effort>
</properties>

Expand All @@ -46,27 +46,12 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-access</artifactId>
<version>${logbackVersion}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logbackVersion}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>${logbackVersion}</version>
</dependency>
<dependency>
<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
Expand All @@ -77,6 +62,11 @@
<artifactId>maven-scm-provider-svnjava</artifactId>
<version>1.12</version>
</dependency>
<dependency>
<groupId>io.jenkins.lib</groupId>
<artifactId>support-log-formatter</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
Expand Down Expand Up @@ -328,6 +318,11 @@
<artifactId>reflections</artifactId>
<version>0.10.2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
Expand Down Expand Up @@ -360,7 +355,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<!-- Version specified in parent POM -->
<configuration>
<archive>
<manifestEntries>
Expand Down Expand Up @@ -407,6 +402,17 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<!-- Version specified in parent POM -->
<configuration>
<systemPropertyVariables>
<java.util.logging.config.class>org.jenkins.tools.test.logging.LoggingConfiguration</java.util.logging.config.class>
</systemPropertyVariables>
<runOrder>alphabetical</runOrder>
</configuration>
</plugin>
</plugins>
</build>
</project>
88 changes: 41 additions & 47 deletions src/main/java/org/jenkins/tools/test/PluginCompatTester.java
View file

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions src/main/java/org/jenkins/tools/test/PluginCompatTesterCli.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import java.util.HashMap;
import java.util.Map;
import org.codehaus.plexus.PlexusContainerException;
import org.jenkins.tools.test.logging.LoggingConfiguration;
import org.jenkins.tools.test.model.PluginCompatTesterConfig;
import org.jenkins.tools.test.exception.PomExecutionException;
import org.jenkins.tools.test.model.TestStatus;
Expand All @@ -47,6 +48,14 @@
*/
public class PluginCompatTesterCli {

static {
String configFile = System.getProperty("java.util.logging.config.file");
String configClass = System.getProperty("java.util.logging.config.class");
if (configClass == null && configFile == null) {
new LoggingConfiguration();
}
}

@SuppressFBWarnings(
value = "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE",
justification =
Expand Down
22 changes: 13 additions & 9 deletions src/main/java/org/jenkins/tools/test/hook/AbstractMultiParentHook.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.maven.scm.ScmException;
import org.apache.maven.scm.ScmFileSet;
Expand All @@ -24,10 +26,12 @@
import org.jenkins.tools.test.model.hook.PluginCompatTesterHookBeforeCheckout;

/**
* Utility class to ease create simple hooks for multimodule projects
* Utility class to ease create simple hooks for multi-module projects
*/
public abstract class AbstractMultiParentHook extends PluginCompatTesterHookBeforeCheckout {

private static final Logger LOGGER = Logger.getLogger(AbstractMultiParentHook.class.getName());

protected boolean firstRun = true;

private PomData pomData;
Expand All @@ -42,10 +46,10 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception
boolean shouldExecuteHook = config.getLocalCheckoutDir() == null || !config.getLocalCheckoutDir().exists();

if (shouldExecuteHook) {
System.out.println("Executing Hook for " + getParentProjectName());
LOGGER.log(Level.INFO, "Executing hook for {0}", getParentProjectName());
// Determine if we need to run the download; only run for first identified plugin in the series
if (firstRun) {
System.out.println("Preparing for Multimodule checkout");
LOGGER.log(Level.INFO, "Preparing for multi-module checkout");

// Checkout to the parent directory. All other processes will be on the child directory
File parentPath = new File(config.workDirectory.getAbsolutePath() + "/" + getParentFolder());
Expand All @@ -54,10 +58,10 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception
String scmTag;
if (pomData.getScmTag() != null) {
scmTag = pomData.getScmTag();
System.out.println(String.format("Using SCM tag '%s' from POM.", scmTag));
LOGGER.log(Level.INFO, "Using SCM tag {0} from POM", scmTag);
} else {
scmTag = getParentProjectName() + "-" + currentPlugin.version;
System.out.println(String.format("POM did not provide an SCM tag. Inferring tag '%s'.", scmTag));
LOGGER.log(Level.INFO, "POM did not provide an SCM tag; inferring tag {0}", scmTag);
}
// Like PluginCompatTester.cloneFromSCM but with subdirectories trimmed:
cloneFromSCM(currentPlugin, parentPath, scmTag, getUrl(), config.getFallbackGitHubOrganization());
Expand All @@ -70,7 +74,7 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception
// Change the "download"" directory; after download, it's simply used for reference
File childPath = new File(config.workDirectory.getAbsolutePath() + "/" + getParentFolder() + "/" + getPluginFolderName(currentPlugin));

System.out.println("Child path for " + currentPlugin.getDisplayName() + " " + childPath);
LOGGER.log(Level.INFO, "Child path for {0}: {1}", new Object[]{currentPlugin.getDisplayName(), childPath.getPath()});
moreInfo.put("checkoutDir", childPath);
moreInfo.put("pluginDir", childPath);
moreInfo.put("parentFolder", getParentFolder());
Expand Down Expand Up @@ -98,7 +102,7 @@ private void cloneFromSCM(UpdateSite.Plugin currentPlugin, File parentPath, Stri
if (connectionURL != null) {
connectionURL = connectionURL.replace("git://", "https://"); // See: https://github.blog/2021-09-01-improving-git-protocol-security-github/
}
System.out.println("Checking out from SCM connection URL: " + connectionURL + " (" + getParentProjectName() + "-" + currentPlugin.version + ") at tag " + scmTag);
LOGGER.log(Level.INFO, "Checking out from SCM connection URL {0}: {1} ({2}-{3}) at tag {4}", new Object[]{connectionURL, getParentProjectName(), currentPlugin.version, scmTag});
if (parentPath.isDirectory()) {
FileUtils.deleteDirectory(parentPath);
}
Expand All @@ -124,11 +128,11 @@ public String getUrl() {

protected void configureLocalCheckOut(UpdateSite.Plugin currentPlugin, File localCheckoutDir, Map<String, Object> moreInfo) {
// Do nothing to keep compatibility with pre-existing Hooks
System.out.println("Ignoring localCheckoutDir for " + currentPlugin.getDisplayName());
LOGGER.log(Level.INFO, "Ignoring local checkout directory for {0}", currentPlugin.getDisplayName());
}

/**
* Returns the folder where the multimodule project parent will be checked out
* Returns the folder where the multi-module project parent will be checked out
*/
protected abstract String getParentFolder();

Expand Down
10 changes: 7 additions & 3 deletions src/main/java/org/jenkins/tools/test/hook/ExampleMultiParent.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.maven.scm.ScmFileSet;
import org.apache.maven.scm.ScmTag;
import org.apache.maven.scm.command.checkout.CheckOutScmResult;
Expand All @@ -19,9 +21,11 @@
* each plugin is in its own repository, these plugins automatically fail since they are "not
* found".
*
* <p>This is an example of what needs to change to handle multimodule parents.
* <p>This is an example of what needs to change to handle multi-module parents.
*/
public class ExampleMultiParent { //extends PluginCompatTesterHookBeforeCheckout {
private static final Logger LOGGER = Logger.getLogger(ExampleMultiParent.class.getName());

private String parentUrl = "scm:git:[email protected]:jenkinsci/parent_repo.git";
private String parentName = "parent_repo";
private List<String> allBundlePlugins = Arrays.asList("possible", "plugins");
Expand Down Expand Up @@ -50,12 +54,12 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception

// Determine if we need to run the download; only run for first identified plugin in the series
if(firstRun){
System.out.println("Preparing for Multimodule checkout.");
LOGGER.log(Level.INFO, "Preparing for multi-module checkout");

// Checkout to the parent directory. All other processes will be on the child directory
File parentPath = new File(config.workDirectory.getAbsolutePath()+"/"+parentName);

System.out.println("Checking out from SCM connection URL : "+parentUrl+" ("+parentName+"-"+currentPlugin.version+")");
LOGGER.log(Level.INFO, "Checking out from SCM connection URL: {0} ({1}-{2})", new Object[]{parentUrl, parentName, currentPlugin.version});
ScmManager scmManager = SCMManagerFactory.getInstance().createScmManager();
ScmRepository repository = scmManager.makeScmRepository(parentUrl);
CheckOutScmResult result = scmManager.checkOut(repository, new ScmFileSet(parentPath), new ScmTag(parentName+"-"+currentPlugin.version));
Expand Down
23 changes: 13 additions & 10 deletions src/main/java/org/jenkins/tools/test/hook/MultiParentCompileHook.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
import java.nio.file.StandardCopyOption;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Stream;

import org.apache.commons.io.FileUtils;
Expand All @@ -25,28 +27,30 @@

public class MultiParentCompileHook extends PluginCompatTesterHookBeforeCompile {

private static final Logger LOGGER = Logger.getLogger(MultiParentCompileHook.class.getName());

protected MavenRunner runner;
protected MavenRunner.Config mavenConfig;

public static final String ESLINTRC = ".eslintrc";

public MultiParentCompileHook() {
System.out.println("Loaded multi-parent compile hook");
LOGGER.log(Level.INFO, "Loaded multi-parent compile hook");
}


@Override
@SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "silly rule")
public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception {
try {
System.out.println("Executing multi-parent compile hook");
LOGGER.log(Level.INFO, "Executing multi-parent compile hook");
PluginCompatTesterConfig config = (PluginCompatTesterConfig) moreInfo.get("config");

runner = new ExternalMavenRunner(config.getExternalMaven());
mavenConfig = getMavenConfig(config);

File pluginDir = (File) moreInfo.get("pluginDir");
System.out.println("Plugin dir is " + pluginDir);
LOGGER.log(Level.INFO, "Plugin dir is {0}", pluginDir);

File localCheckoutDir = config.getLocalCheckoutDir();
if (localCheckoutDir != null) {
Expand All @@ -72,12 +76,11 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception
moreInfo.put(OVERRIDE_DEFAULT_COMPILE, true);
}

System.out.println("Executed multi-parent compile hook");
LOGGER.log(Level.INFO, "Executed multi-parent compile hook");
return moreInfo;
// Exceptions get swallowed, so we print to console here and rethrow again
} catch (Exception e) {
System.out.println("Exception executing hook");
System.out.println(e);
LOGGER.log(Level.WARNING, "Exception executing hook", e);
throw e;
}
}
Expand Down Expand Up @@ -142,12 +145,12 @@ private boolean isSnapshotMultiParentPlugin(String parentFolder, File path, File
return false;
}
if (!path.getAbsolutePath().contains(parentFolder)) {
System.out.println(String.format("Something is really wrong here! parentFolder:%s not present in path %s", parentFolder, path.getAbsolutePath()));
LOGGER.log(Level.WARNING, "Parent folder {0} not present in path {1}", new Object[]{parentFolder, path.getAbsolutePath()});
return false;
}
File parentFile = path.getParentFile();
if (!StringUtils.equals(parentFolder, parentFile.getName())) {
System.out.println(String.format("Something is really wrong here! %s is not the parent folder of %s", parentFolder, path.getAbsolutePath()));
LOGGER.log(Level.WARNING, "{0} is not the parent folder of {1}", new Object[]{parentFolder, path.getAbsolutePath()});
return false;
}

Expand All @@ -159,9 +162,9 @@ private boolean isSnapshotMultiParentPlugin(String parentFolder, File path, File


private File setupCompileResources(File path) throws IOException {
System.out.println("Cleaning up node modules if necessary");
LOGGER.log(Level.INFO, "Cleaning up node modules if necessary");
removeNodeFolders(path);
System.out.println("Compile plugin log in " + path);
LOGGER.log(Level.INFO, "Plugin compilation log directory: {0}", path);
return new File(path + "/compilePluginLog.log");
}

Expand Down
13 changes: 8 additions & 5 deletions src/main/java/org/jenkins/tools/test/hook/NodeCleanupBeforeCompileHook.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@
import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

public class NodeCleanupBeforeCompileHook extends PluginCompatTesterHookBeforeCompile {

private static final Logger LOGGER = Logger.getLogger(NodeCleanupBeforeCompileHook.class.getName());

@Override
public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception {
PluginCompatTesterConfig config = (PluginCompatTesterConfig) moreInfo.get("config");
Expand All @@ -19,16 +23,15 @@ public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception
if (shouldExecuteHook) {
File pluginDir = (File) moreInfo.get("pluginDir");
try {
System.out.println("Executing node and node_modules cleanup hook");
LOGGER.log(Level.INFO, "Executing node and node_modules cleanup hook");
compile(pluginDir);
return moreInfo;
} catch (Exception e) {
System.out.println("Exception executing hook");
System.out.println(e);
LOGGER.log(Level.WARNING, "Exception executing hook", e);
throw e;
}
} else {
System.out.println("Hook not triggered. Continuing.");
LOGGER.log(Level.INFO, "Hook not triggered; continuing");
return moreInfo;
}
}
Expand All @@ -38,7 +41,7 @@ public void validate(Map<String, Object> toCheck) {
}

private void compile(File path) throws PomExecutionException, IOException {
System.out.println("Calling removeNodeFolders");
LOGGER.log(Level.INFO, "Calling removeNodeFolders");
removeNodeFolders(path);
}

Expand Down
Loading

0 comments on commit b334867

Please sign in to comment.