Minor Updates

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 
 on:
  release:
- types: [published]
+ types: [ published ]
 
 jobs:
  build:

.mvn/quality-configs/checkstyle/checkstyle.xml

@@ -104,10 +104,10 @@
  <module name="PackageDeclaration"/>
  <module name="ParameterAssignment"/> <!-- more strict version is FinalParameters -->
  <!--<module name="RequireThis"/>-->
-<!-- <module name="ReturnCount">-->
-<!-- <property name="max" value="5"/>-->
-<!-- <property name="maxForVoid" value="3"/>-->
-<!-- </module>-->
+ <!-- <module name="ReturnCount">-->
+ <!-- <property name="max" value="5"/>-->
+ <!-- <property name="maxForVoid" value="3"/>-->
+ <!-- </module>-->
  <module name="SimplifyBooleanExpression"/>
  <module name="SimplifyBooleanReturn"/>
  <module name="StringLiteralEquality"/>
@@ -136,9 +136,9 @@
  <!-- org.springframework.data.util"-->
  <!-- />-->
  <!-- </module>-->
-<!-- <module name="ImportControl">-->
-<!-- <property name="file" value="${config_loc}/import-control.xml"/>-->
-<!-- </module>-->
+ <!-- <module name="ImportControl">-->
+ <!-- <property name="file" value="${config_loc}/import-control.xml"/>-->
+ <!-- </module>-->
  <!--<module name="ImportOrder"/>-->
  <module name="RedundantImport"/>
  <module name="UnusedImports"/>

.mvn/quality-configs/pmd/pmd.xml

@@ -112,7 +112,8 @@
  <exclude name="JUnitStaticSuite"/>
  <exclude name="LoggerIsNotStaticFinal"/>
  <exclude name="MissingSerialVersionUID"/>
- <exclude name="NullAssignment"/> <!-- disabled due to false positive for initialization with ternary operator -->
+ <exclude
+ name="NullAssignment"/> <!-- disabled due to false positive for initialization with ternary operator -->
  <exclude name="StaticEJBFieldShouldBeFinal"/> <!-- earlier j2ee group-->
  <exclude name="UseCorrectExceptionLogging"/>
  <exclude name="UseLocaleWithCaseConversions"/>

.mvn/quality-configs/spotbugs/exclude.xml

@@ -13,7 +13,7 @@
  you will have to use @NotNull annotation, which contradict with original contract
  (actually not, because guava intend weaker semantics). So disable this check to be able to properly
  use nullability annotations -->
- <Bug pattern="NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION" />
+ <Bug pattern="NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION"/>
  </Match>
  <Match>
  <!-- Disabled as confusing check (very misleading description) and also not so useful -->

README.md

@@ -1,17 +1,29 @@
 ## Allure Bamboo Plugin
 
-This repository contains source code of Allure plugin for [Atlassian Bamboo CI](https://www.atlassian.com/software/bamboo). It allows you to generate Allure report from [existing Allure XML files](https://github.com/allure-framework/allure-core/wiki#gathering-information-about-tests).
+This repository contains source code of Allure plugin
+for [Atlassian Bamboo CI](https://www.atlassian.com/software/bamboo). It allows you to generate Allure report
+from [existing Allure XML files](https://github.com/allure-framework/allure-core/wiki#gathering-information-about-tests).
 
 ### Building and Installing
+
 #### Short way
-Download precompiled JAR from [releases page](https://github.com/allure-framework/allure-bamboo-plugin/releases) and install it manually as described [here](https://confluence.atlassian.com/display/UPM/Installing+add-ons#Installingadd-ons-Installingbyfileupload). We use JDK 1.7+ to compile the plugin so be sure to use Java 1.7+ for running Bamboo.
+
+Download precompiled JAR from [releases page](https://github.com/allure-framework/allure-bamboo-plugin/releases) and
+install it manually as
+described [here](https://confluence.atlassian.com/display/UPM/Installing+add-ons#Installingadd-ons-Installingbyfileupload).
+We use JDK 1.7+ to compile the plugin so be sure to use Java 1.7+ for running Bamboo.
+
 #### Long way
-1. Set up Atlassian plugin SDK as described [here](https://developer.atlassian.com/display/DOCS/Set+up+the+Atlassian+Plugin+SDK+and+Build+a+Project).
+
+1. Set up Atlassian plugin SDK as
+described [here](https://developer.atlassian.com/display/DOCS/Set+up+the+Atlassian+Plugin+SDK+and+Build+a+Project).
 2. Clone this repository
 3. Run `$ atlas-run`
 4. Access http://localhost:6990/bamboo/ to view development instance of Bamboo
 5. Verify that plugin is working as expected
-6. Install **target/allure-bamboo-plugin-VERSION.jar** manually as described [here](https://confluence.atlassian.com/display/UPM/Installing+add-ons#Installingadd-ons-Installingbyfileupload).
+6. Install **target/allure-bamboo-plugin-VERSION.jar** manually as
+described [here](https://confluence.atlassian.com/display/UPM/Installing+add-ons#Installingadd-ons-Installingbyfileupload).
 
 ### Configuration and Usage
+
 Please follow the guide on the official Allure docs: https://docs.qameta.io/allure/#_bamboo

pom.xml

@@ -234,6 +234,7 @@
  <version>${spotless.version}</version>
  <configuration>
  <encoding>UTF-8</encoding>
+ <lineEndings>UNIX</lineEndings>
  <!-- optional: limit format enforcement to just the files changed by this feature branch -->
  <formats>
  <!-- you can define as many formats as you want, each is independent -->
@@ -263,7 +264,7 @@
  </includes>
  <!-- <removeUnusedImports/> Some bug exists with it-->
  <importOrder> <!-- or a custom ordering -->
- <order> ,jakarta,javax,java,\#</order>
+ <order>,jakarta,javax,java,\#</order>
  </importOrder>
  <licenseHeader>
  <file>.mvn/quality-configs/spotless/allure.java.license</file>

src/main/java/io/qameta/allure/bamboo/AllureArtifactsManager.java

@@ -147,7 +147,7 @@ Optional<String> getArtifactUrl(final String planKeyString,
  .flatMap(rs -> getArtifactHandlerByClassName(
  fromCustomData(rs.getCustomBuildData()).getArtifactHandlerClass())
  .map(handler -> getArtifactUrl(planKeyString, buildNumber,
-  filePath, artifactConfig, planResultKey, handler)
+ filePath, artifactConfig, planResultKey, handler)
  )
  );
  }
@@ -164,10 +164,10 @@ private String getArtifactUrl(final String planKeyString,
  final ArtifactDefinitionContextImpl artifactDef = getAllureArtifactDef();
 
  return Optional.ofNullable(
- artifactHandler.getArtifactLinkDataProvider(
- mutableArtifact(planResultKey, artifactDef.getName()),
- configProvider(artifactConfig)
- ))
+  artifactHandler.getArtifactLinkDataProvider(
+  mutableArtifact(planResultKey, artifactDef.getName()),
+  configProvider(artifactConfig)
+  ))
  .map(lp -> getArtifactUrl(filePath, planResultKey, artifactDef, lp))
  .orElse(null);
  }
@@ -326,19 +326,19 @@ Optional<AllureBuildResult> uploadReportArtifacts(final @NotNull ImmutableChain
  final String errorMessage = "Unable to publish artifact via " + artifactHandler;
  final ArtifactHandlerPublishingResult publishingResult = BambooPluginUtils.callUnsafeCode(
  new BambooPluginUtils.NoThrowCallable<ArtifactHandlerPublishingResult>(errorMessage) {
- @NotNull
- @Override
- public ArtifactHandlerPublishingResult call() {
- try {
- return artifactHandler.publish(
- summary.getPlanResultKey(), artifact, artifactPublishingConfig);
- } catch (final Exception e) {
- LOGGER.error("Failed to publish Allure Report using handler "
- + artifactHandler.getClass().getName(), e);
- return ArtifactHandlerPublishingResultImpl.failure();
- }
- }
- });
+  @NotNull
+  @Override
+  public ArtifactHandlerPublishingResult call() {
+  try {
+  return artifactHandler.publish(
+  summary.getPlanResultKey(), artifact, artifactPublishingConfig);
+  } catch (final Exception e) {
+  LOGGER.error("Failed to publish Allure Report using handler "
+  + artifactHandler.getClass().getName(), e);
+  return ArtifactHandlerPublishingResultImpl.failure();
+  }
+  }
+  });
  if (publishingResult != null) {
  publishingResult.setArtifactHandlerKey(artifactHandler.getModuleDescriptor().getCompleteKey());
  return Optional.of(allureBuildResult(publishingResult.isSuccessful(), null)
@@ -451,17 +451,17 @@ private <T extends ArtifactHandler> Optional<T> getArtifactHandlerByClassName(fi
  final AtomicReference<Predicate<ModuleDescriptor<T>>> predicate = new AtomicReference<>();
  return Optional.ofNullable(className)
  .map(clazz -> {
- final Class<T> aClass;
- try {
- aClass = (Class<T>) Class.forName(clazz);
- predicate.set(new ModuleOfClassPredicate<>(aClass).and(new EnabledModulePredicate()));
-
- return pluginAccessor.getModules(predicate.get()).stream().findAny().orElse(null);
- } catch (ClassNotFoundException e) {
- LOGGER.error("Failed to find artifact handler for class name " + className, e);
+ final Class<T> aClass;
+ try {
+ aClass = (Class<T>) Class.forName(clazz);
+ predicate.set(new ModuleOfClassPredicate<>(aClass).and(new EnabledModulePredicate()));
+
+ return pluginAccessor.getModules(predicate.get()).stream().findAny().orElse(null);
+ } catch (ClassNotFoundException e) {
+ LOGGER.error("Failed to find artifact handler for class name " + className, e);
+ }
+ return null;
  }
- return null;
- }
  );
  }
 }

src/main/java/io/qameta/allure/bamboo/AllureBuildCompleteAction.java

@@ -125,6 +125,9 @@ public void execute(final @NotNull ImmutableChain chain,
  final AllureExecutable allure = allureExecutable.provide(globalConfig, executable)
  .orElseThrow(() -> new RuntimeException("Failed to find Allure executable by name " + executable));
 
+ // Creating a copy for customize report
+ final AllureExecutable allureTmp = allure.getCopy();
+
  LOGGER.info("Starting artifacts downloading into {} for {}", artifactsTempDir.getPath(), chain.getName());
  final Collection<Path> artifactsPaths = artifactsManager.downloadAllArtifactsTo(
  chainResultsSummary, artifactsTempDir, buildConfig.getArtifactName());
@@ -137,9 +140,9 @@ public void execute(final @NotNull ImmutableChain chain,
 
  // Setting the new logo in the allure libraries before generate the report.
  if (globalConfig.isCustomLogoEnabled()) {
- allure.setCustomLogo(buildConfig.getCustomLogoUrl());
+ allureTmp.setCustomLogo(buildConfig.getCustomLogoUrl());
  }
- allure.generate(artifactsPaths, allureReportDir.toPath());
+ allureTmp.generate(artifactsPaths, allureReportDir.toPath());
  // Setting report name
  this.finalizeReport(allureReportDir,
  chainExecution.getPlanResultKey().getBuildNumber(), chain.getBuildName());

src/main/java/io/qameta/allure/bamboo/AllureBuildConfig.java

@@ -16,7 +16,6 @@
 package io.qameta.allure.bamboo;
 
 import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.validator.routines.UrlValidator;
 
 import javax.annotation.Nullable;
 import java.io.Serializable;
@@ -49,9 +48,7 @@ private AllureBuildConfig(final String executable,
  this.enabled = StringUtils.isEmpty(enabled) ? FALSE : Boolean.parseBoolean(enabled);
  this.executable = executable;
  this.artifactName = artifactName;
- // If the URL is not a valid URL it will be omitted
- final UrlValidator urlValidator = new UrlValidator();
- this.logoUrl = urlValidator.isValid(logoUrl) ? logoUrl : AllureBuildConfig.DEFAULT_CUSTOM_LOGO_URL;
+ this.logoUrl = !logoUrl.isEmpty() ? logoUrl : AllureBuildConfig.DEFAULT_CUSTOM_LOGO_URL;
  }
 
  static AllureBuildConfig fromContext(final Map<String, String> context) {

src/main/java/io/qameta/allure/bamboo/AllureDownloader.java

@@ -79,8 +79,8 @@ private Optional<Path> downloadAllure(final String version) {
  return Downloader.download(url, downloadToFile);
  } catch (Exception e) {
  LOGGER
- .warn("Failed to download from {}. Root cause : {}.",
- url, e.toString());
+  .warn("Failed to download from {}. Root cause : {}.",
+  url, e.toString());
  }
  }
  } catch (Exception e) {
@@ -91,11 +91,11 @@ private Optional<Path> downloadAllure(final String version) {
 
  private URL[] buildAllureDownloadUrls(final String version) throws MalformedURLException {
  final URL gitUrl = fromPath(settingsManager.getSettings().getDownloadBaseUrl())
- .path(String.format("%s/allure-%s.zip", version, version))
- .build().toURL();
+  .path(String.format("%s/allure-%s.zip", version, version))
+  .build().toURL();
  final URL mavenUrl = fromPath(settingsManager.getSettings().getDownloadCliBaseUrl())
- .path(String.format("allure-commandline/%s/allure-commandline-%s.zip", version, version))
- .build().toURL();
+  .path(String.format("allure-commandline/%s/allure-commandline-%s.zip", version, version))
+  .build().toURL();
  return new URL[]{gitUrl, mavenUrl};
  }
 }

src/main/java/io/qameta/allure/bamboo/AllureExecutable.java

@@ -25,15 +25,15 @@
 import javax.annotation.Nonnull;
 import java.io.File;
 import java.io.IOException;
-import java.net.URL;
 import java.nio.file.Path;
 import java.util.Collection;
 import java.util.LinkedList;
 import java.util.regex.Pattern;
 
+import static java.nio.file.Files.createTempDirectory;
 import static java.util.Arrays.asList;
 import static java.util.stream.Collectors.toList;
-import static javax.ws.rs.core.UriBuilder.fromPath;
+import static org.apache.commons.io.FileUtils.copyDirectoryToDirectory;
 
 class AllureExecutable {
 
@@ -87,11 +87,10 @@ public void setCustomLogo(final String logoUrl) {
  objectMapper.writeValue(configFile, ap);
  }
  //Setting new Logo
- final URL srcLogoUrl = fromPath(logoUrl).build().toURL();
  FileStringReplacer.replaceInFile(logoPluginFolder.resolve(cssFileName),
  Pattern.compile("url\\('.+'\\)",
  Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.COMMENTS),
- "url(" + srcLogoUrl.toString() + ")"
+ "url(" + logoUrl + ")"
  );
 
  // aligning logo to center
@@ -100,6 +99,12 @@ public void setCustomLogo(final String logoUrl) {
  Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.COMMENTS),
  "center"
  );
+ // fit logo to area
+ FileStringReplacer.replaceInFile(logoPluginFolder.resolve(cssFileName),
+ Pattern.compile("(?<=\\s )!important;",
+ Pattern.CASE_INSENSITIVE | Pattern.MULTILINE | Pattern.COMMENTS),
+ "!important; background-size: contain !important;"
+ );
  // removing margin
  FileStringReplacer.replaceInFile(logoPluginFolder.resolve(cssFileName),
  Pattern.compile("10px",
@@ -113,6 +118,22 @@ public void setCustomLogo(final String logoUrl) {
  }
  }
 
+ public AllureExecutable getCopy() throws IOException {
+ final String binary = this.cmdPath.getFileName().toString();
+ final String binFolder = this.cmdPath.getParent().getFileName().toString();
+ final Path rootPath = this.cmdPath.getParent().getParent();
+ final Path rootFolderName = rootPath.getFileName();
+ final Path copyPath = createTempDirectory(rootFolderName.toString());
+ copyDirectoryToDirectory(rootPath.toFile(), copyPath.toFile());
+
+ return new AllureExecutable(copyPath
+ .resolve(rootFolderName.toString())
+ .resolve(binFolder)
+ .resolve(binary),
+ this.cmdLine
+ );
+ }
+
  Path getCmdPath() {
  return cmdPath;
  }

src/main/java/io/qameta/allure/bamboo/AllureExecutableProvider.java

@@ -70,7 +70,7 @@ Optional<AllureExecutable> provide(final boolean isDownloadEnabled, final String
  } else if (isDownloadEnabled) {
  final Matcher nameMatcher = EXEC_NAME_PATTERN.matcher(executableName);
  return allureDownloader.downloadAndExtractAllureTo(allureHomeSubDir,
- nameMatcher.matches() ? nameMatcher.group(1) : DEFAULT_VERSION)
+  nameMatcher.matches() ? nameMatcher.group(1) : DEFAULT_VERSION)
  .map(path -> executable).orElse(null);
  }
  return null;

src/main/java/io/qameta/allure/bamboo/AllureReportServlet.java

@@ -100,7 +100,7 @@ private void setResponseHeaders(final HttpServletResponse response,
  final URI file = new URL(fileUrl).toURI();
  final String mimeType = Optional.ofNullable(getServletContext().getMimeType(fileUrl))
  .orElse(Files.probeContentType(Paths.get(file.getPath()))
- );
+  );
  final String charsetPostfix = Stream.of("application", "text")
  .anyMatch(mimeType::contains) ? ";charset=utf-8" : "";
  response.setHeader(CONTENT_TYPE, mimeType + charsetPostfix);
@@ -152,7 +152,7 @@ private void uploadResultWasNotSuccess(final HttpServletResponse response,
  final String errorMessage = isEmpty(uploadResult.getFailureDetails())
  ? "Unknown error has occurred during Allure Build. Please refer the server logs for details."
  : "Something went wrong with Allure Report generation. Here are some details: \n"
-  + uploadResult.getFailureDetails();
+ + uploadResult.getFailureDetails();
  try {
  response.setHeader(CONTENT_TYPE, "text/plain");
  response.setHeader("Content-Length", String.valueOf(errorMessage.length()));

src/main/java/io/qameta/allure/bamboo/BambooExecutablesManager.java

@@ -84,7 +84,7 @@ void addDefaultAllureExecutableCapability() {
  final CapabilityImpl capability = new CapabilityImpl(key, DEFAULT_PATH);
  capSet.addCapability(capability);
  capabilitySetManager.saveCapabilitySet(capSet);
- });
+  });
  }
 
  @NotNull

src/main/java/io/qameta/allure/bamboo/info/allurewidgets/summary/Statistic.java

@@ -43,7 +43,6 @@ public class Statistic extends AbstractSummary {
 
  /**
  * No args constructor for use in serialization.
- *
  */
  public Statistic() {
  // empty