Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ARTEMIS-3914 Document client classpath automated
- Loading branch information
1 parent
d67910f
commit 0cd203c
Showing
8 changed files
with
408 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
257 changes: 257 additions & 0 deletions
257
...en-plugin/src/main/java/org/apache/activemq/artemis/maven/ArtemisDependencyDocPlugin.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.activemq.artemis.maven; | ||
|
|
||
| import java.io.BufferedOutputStream; | ||
| import java.io.File; | ||
| import java.io.FileOutputStream; | ||
| import java.io.IOException; | ||
| import java.io.PrintStream; | ||
| import java.util.Collections; | ||
| import java.util.Comparator; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.apache.maven.plugin.descriptor.PluginDescriptor; | ||
| import org.apache.maven.plugins.annotations.LifecyclePhase; | ||
| import org.apache.maven.plugins.annotations.Mojo; | ||
| import org.apache.maven.plugins.annotations.Parameter; | ||
| import org.apache.maven.project.MavenProject; | ||
| import org.eclipse.aether.artifact.Artifact; | ||
| import org.eclipse.aether.repository.RemoteRepository; | ||
| import org.eclipse.aether.resolution.ArtifactResult; | ||
|
|
||
| /** The following substitutions are made for each line | ||
| * X{group} with the groupID | ||
| * X{artifact} with the artifactID | ||
| * X{version} with the version | ||
| * X{classifier} with the classifier of the component | ||
| * X{package} a combination of the maven group:artifact:classifier | ||
| * X{url} with the url | ||
| * X{file} with the fileName | ||
| * X{fileMD} with the fileName on a LINK with MD style | ||
| * X{URI} with the URI | ||
| * X{detail} with the detail provided in the config */ | ||
| @Mojo(name = "dependency-doc", defaultPhase = LifecyclePhase.VERIFY) | ||
| public class ArtemisDependencyDocPlugin extends ArtemisAbstractPlugin { | ||
|
|
||
| @Parameter | ||
| String name; | ||
|
|
||
| /** | ||
| * The plugin descriptor | ||
| */ | ||
| private PluginDescriptor descriptor; | ||
|
|
||
| @Parameter | ||
| private String[] groupOrder; | ||
|
|
||
| @Parameter(defaultValue = "https://repo.maven.apache.org/maven2") | ||
| private String defaultRepo = "https://repo.maven.apache.org/maven2"; | ||
|
|
||
| @Parameter | ||
| private String header; | ||
|
|
||
| @Parameter | ||
| private String lib; | ||
|
|
||
| @Parameter | ||
| private String line; | ||
|
|
||
| @Parameter | ||
| private String footer; | ||
|
|
||
| @Parameter | ||
| private String[] detailKey; | ||
|
|
||
| @Parameter String[] detailValue; | ||
|
|
||
| @Parameter | ||
| private String[] extraRepositories; | ||
|
|
||
| @Parameter | ||
| private String file; | ||
|
|
||
| private MavenProject project; | ||
|
|
||
| @Override | ||
| protected boolean isIgnore() { | ||
| return false; | ||
| } | ||
|
|
||
|
|
||
| private String applyFilters(String content, Map<String, String> filters) throws IOException { | ||
|
|
||
| if (filters != null) { | ||
| for (Map.Entry<String, String> entry : filters.entrySet()) { | ||
| try { | ||
| content = replace(content, entry.getKey(), entry.getValue()); | ||
| } catch (Throwable e) { | ||
| System.out.println("Error on " + entry.getKey()); | ||
| e.printStackTrace(); | ||
| } | ||
| } | ||
| } | ||
| return content; | ||
| } | ||
|
|
||
|
|
||
| private String replace(String content, String key, String value) { | ||
| return content.replaceAll(Pattern.quote(key), Matcher.quoteReplacement(value)); | ||
| } | ||
|
|
||
| private String getPackageName(org.eclipse.aether.artifact.Artifact artifact) { | ||
| return artifact.getGroupId() + ":" + artifact.getArtifactId() + (artifact.getClassifier() != null && !artifact.getClassifier().equals("") ? ":" + artifact.getClassifier() : ""); | ||
| } | ||
|
|
||
| private String getGroupOrder(String group) { | ||
| if (groupOrder == null) { | ||
| groupOrder = new String[] {"org.apache.activemq"}; | ||
| } | ||
|
|
||
| int i = 0; | ||
| for (; i < groupOrder.length; i++) { | ||
| if (group.equals(groupOrder[i])) { | ||
| return Integer.toString(i); | ||
| } | ||
| } | ||
| return Integer.toString(i); | ||
| } | ||
|
|
||
| @Override | ||
| protected void doExecute() { | ||
|
|
||
| HashMap<String, String> keys = new HashMap<>(); | ||
|
|
||
| if (detailKey != null) { | ||
| if (detailValue == null) { | ||
| throw new IllegalStateException("you need to specify all detail parameters"); | ||
| } | ||
|
|
||
| if (detailKey.length != detailValue.length) { | ||
| throw new IllegalStateException("Illegal argument size"); | ||
| } | ||
|
|
||
| for (int i = 0; i < detailKey.length; i++) { | ||
| keys.put(detailKey[i], detailValue[i]); | ||
| } | ||
| } | ||
|
|
||
| if (file == null) { | ||
| throw new IllegalStateException("you must specify the file output"); | ||
| } | ||
|
|
||
| if (line == null) { | ||
| throw new IllegalStateException("you must specify the line"); | ||
| } | ||
|
|
||
|
|
||
| try { | ||
| File javaFile = new File(file); | ||
| javaFile.getParentFile().mkdirs(); | ||
|
|
||
| PrintStream stream = new PrintStream(new BufferedOutputStream(new FileOutputStream(file))); | ||
|
|
||
| if (header != null) { | ||
| stream.println(header); | ||
| } | ||
|
|
||
| List<org.eclipse.aether.artifact.Artifact> artifacts = explodeDependencies(newArtifact(lib)); | ||
|
|
||
| Collections.sort(artifacts, new Comparator<Artifact>() { | ||
| @Override | ||
| public int compare(Artifact o1, Artifact o2) { | ||
| String pref1 = getGroupOrder(o1.getGroupId()); | ||
| String pref2 = getGroupOrder(o2.getGroupId()); | ||
| return (pref1 + o1.getGroupId() + o1.getArtifactId()).compareTo(pref2 + o2.getGroupId() + o2.getArtifactId()); | ||
| } | ||
| }); | ||
|
|
||
| artifacts.forEach((art) -> { | ||
| try { | ||
|
|
||
| String detail = keys.get(art.getGroupId() + ":" + art.getArtifactId()); | ||
| if (detail == null) { | ||
| detail = ""; | ||
| } | ||
|
|
||
| ArtifactResult result = resolveArtifact(art); | ||
|
|
||
| HashMap<String, String> filter = new HashMap<>(); | ||
| filter.put("X{detail}", detail); | ||
| filter.put("X{group}", art.getGroupId()); | ||
| filter.put("X{artifact}", art.getArtifactId()); | ||
| filter.put("X{classifier}", result.getArtifact().getClassifier()); | ||
| filter.put("X{package}", getPackageName(result.getArtifact())); | ||
| filter.put("X{file}", result.getArtifact().getFile().getName()); | ||
| filter.put("X{version}", result.getArtifact().getVersion()); | ||
|
|
||
| String uri = getURI(result); | ||
|
|
||
| filter.put("X{uri}", uri); | ||
|
|
||
| if (uri.equals("")) { | ||
| filter.put("X{fileMD}", result.getArtifact().getFile().getName()); | ||
| } else { | ||
| filter.put("X{fileMD}", "[" + result.getArtifact().getFile().getName() + "](" + uri + ")"); | ||
| } | ||
|
|
||
| String output = applyFilters(line, filter); | ||
|
|
||
| if (getLog().isDebugEnabled()) { | ||
| filter.forEach((a, b) -> { | ||
| getLog().debug("filter.put(" + a + ", " + b + ")"); | ||
| }); | ||
| getLog().debug(output); | ||
| } | ||
|
|
||
|
|
||
| stream.println(output); | ||
|
|
||
| } catch (Exception e) { | ||
| throw new RuntimeException(e.getMessage(), e); | ||
| } | ||
| }); | ||
| if (footer != null) { | ||
| stream.println(footer); | ||
| } | ||
| stream.close(); | ||
| } catch (Throwable e) { | ||
| getLog().error(e.getMessage(), e); | ||
| } | ||
| } | ||
|
|
||
| private String getURI(ArtifactResult result) { | ||
| Artifact art = result.getArtifact(); | ||
| String uri = ""; | ||
| if (result.getRepository() instanceof RemoteRepository) { | ||
| RemoteRepository remoteRepository = (RemoteRepository) result.getRepository(); | ||
| uri = remoteRepository.getUrl(); | ||
| } else { | ||
| uri = defaultRepo; | ||
| } | ||
|
|
||
| return uri + "/" + | ||
| art.getGroupId().replace('.', '/') + "/" + | ||
| art.getArtifactId() + "/" + | ||
| art.getVersion(); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.