This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 554df3c3fe4d2c234560fc8c0a627ef51e80442d Author: Claus Ibsen <[email protected]> AuthorDate: Thu Jun 15 15:14:19 2023 +0200 CAMEL-19459: camel-catalog-maven-grape --- catalog/camel-catalog-maven-grape/pom.xml | 126 ++++++++++++ .../catalog/maven/ComponentArtifactHelper.java | 95 +++++++++ .../maven/DefaultMavenArtifactProvider.java | 141 ++++++++++++++ .../camel/catalog/maven/MavenArtifactProvider.java | 60 ++++++ .../camel/catalog/maven/MavenVersionManager.java | 214 +++++++++++++++++++++ .../catalog/maven/TimeoutHttpClientHandler.java | 72 +++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ .../maven/MavenArtifactProviderManualTest.java | 49 +++++ .../maven/MavenVersionManagerManualTest.java | 153 +++++++++++++++ .../src/test/resources/log4j2.properties | 28 +++ catalog/pom.xml | 1 + 12 files changed, 1153 insertions(+) diff --git a/catalog/camel-catalog-maven-grape/pom.xml b/catalog/camel-catalog-maven-grape/pom.xml new file mode 100644 index 00000000000..85bbcd47e1e --- /dev/null +++ b/catalog/camel-catalog-maven-grape/pom.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + 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. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>catalog</artifactId> + <version>4.0.0-SNAPSHOT</version> + </parent> + + <artifactId>camel-catalog-maven-grape</artifactId> + <packaging>jar</packaging> + <name>Camel :: Catalog :: Maven Grape</name> + <description>Camel Catalog Maven using Grape</description> + + <properties> + <firstVersion>2.18.0</firstVersion> + <label>tooling</label> + </properties> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-catalog</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + </dependency> + + <dependency> + <groupId>org.apache.httpcomponents</groupId> + <artifactId>httpclient</artifactId> + <exclusions> + <exclusion> + <groupId>commons-codec</groupId> + <artifactId>commons-codec</artifactId> + </exclusion> + </exclusions> + <version>${httpclient4-version}</version> + </dependency> + <dependency> + <groupId>org.apache.httpcomponents</groupId> + <artifactId>httpcore</artifactId> + <exclusions> + <exclusion> + <groupId>commons-codec</groupId> + <artifactId>commons-codec</artifactId> + </exclusion> + </exclusions> + <version>${httpcore4-version}</version> + </dependency> + <dependency> + <groupId>commons-codec</groupId> + <artifactId>commons-codec</artifactId> + <version>${commons-codec-version}</version> + </dependency> + + <!-- disable all components --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-allcomponents</artifactId> + <version>${project.version}</version> + <type>pom</type> + <exclusions> + <exclusion> + <groupId>org.apache.camel</groupId> + <artifactId>*</artifactId> + </exclusion> + </exclusions> + </dependency> + + <!-- use groovy grape to download JARs as that is easy to use --> + <dependency> + <groupId>org.apache.groovy</groupId> + <artifactId>groovy</artifactId> + <version>${groovy-version}</version> + </dependency> + <dependency> + <groupId>org.apache.ivy</groupId> + <artifactId>ivy</artifactId> + <version>${ivy-version}</version> + </dependency> + + <!-- testing --> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter</artifactId> + <scope>test</scope> + </dependency> + + <!-- logging --> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-slf4j2-impl</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-core</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + +</project> diff --git a/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/ComponentArtifactHelper.java b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/ComponentArtifactHelper.java new file mode 100644 index 00000000000..70d88f1c7fb --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/ComponentArtifactHelper.java @@ -0,0 +1,95 @@ +/* + * 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.camel.catalog.maven; + +import java.io.InputStream; +import java.util.Properties; + +import static org.apache.camel.catalog.impl.CatalogHelper.loadText; + +/** + * Helper methods for loading content from Camel components that the {@link org.apache.camel.catalog.CamelCatalog} + * requires. + */ +public final class ComponentArtifactHelper { + + private ComponentArtifactHelper() { + } + + public static Properties loadComponentProperties(boolean log, ClassLoader classLoader) { + Properties answer = new Properties(); + try { + // load the component files using the recommended way by a component.properties file + InputStream is = classLoader.getResourceAsStream("META-INF/services/org/apache/camel/component.properties"); + if (is != null) { + answer.load(is); + } + } catch (Exception e) { + if (log) { + System.out.println("WARN: Error loading META-INF/services/org/apache/camel/component.properties file due " + + e.getMessage()); + } + } + return answer; + } + + public static String extractComponentJavaType(boolean log, ClassLoader classLoader, String scheme) { + try { + InputStream is = classLoader.getResourceAsStream("META-INF/services/org/apache/camel/component/" + scheme); + if (is != null) { + Properties props = new Properties(); + props.load(is); + return (String) props.get("class"); + } + } catch (Exception e) { + if (log) { + System.out.println("WARN: Error loading META-INF/services/org/apache/camel/component/" + scheme + " file due " + + e.getMessage()); + } + } + + return null; + } + + public static String loadComponentJSonSchema(boolean log, ClassLoader classLoader, String scheme) { + String answer = null; + + String path = null; + String javaType = extractComponentJavaType(log, classLoader, scheme); + if (javaType != null) { + int pos = javaType.lastIndexOf('.'); + path = javaType.substring(0, pos); + path = path.replace('.', '/'); + path = path + "/" + scheme + ".json"; + } + + if (path != null) { + try { + InputStream is = classLoader.getResourceAsStream(path); + if (is != null) { + answer = loadText(is); + } + } catch (Exception e) { + if (log) { + System.out.println("WARN: Error loading " + path + " file due " + e.getMessage()); + } + } + } + + return answer; + } +} diff --git a/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/DefaultMavenArtifactProvider.java b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/DefaultMavenArtifactProvider.java new file mode 100644 index 00000000000..97e41203e23 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/DefaultMavenArtifactProvider.java @@ -0,0 +1,141 @@ +/* + * 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.camel.catalog.maven; + +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Properties; +import java.util.Set; + +import groovy.grape.Grape; +import groovy.lang.GroovyClassLoader; +import org.apache.camel.catalog.CamelCatalog; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.camel.catalog.maven.ComponentArtifactHelper.extractComponentJavaType; +import static org.apache.camel.catalog.maven.ComponentArtifactHelper.loadComponentJSonSchema; +import static org.apache.camel.catalog.maven.ComponentArtifactHelper.loadComponentProperties; + +/** + * Default {@link MavenArtifactProvider} which uses Groovy Grape to download the artifact. + */ +public class DefaultMavenArtifactProvider implements MavenArtifactProvider { + + private static final Logger LOGGER = LoggerFactory.getLogger(DefaultMavenArtifactProvider.class); + private String cacheDirectory; + private boolean log; + + /** + * Sets whether to log errors and warnings to System.out. By default nothing is logged. + */ + public void setLog(boolean log) { + this.log = log; + } + + @Override + public void setCacheDirectory(String directory) { + this.cacheDirectory = directory; + } + + @Override + public void addMavenRepository(String name, String url) { + Map<String, Object> repo = new HashMap<>(); + repo.put("name", name); + repo.put("root", url); + Grape.addResolver(repo); + } + + @Override + public Set<String> addArtifactToCatalog( + CamelCatalog camelCatalog, + String groupId, String artifactId, String version) { + final Set<String> names = new LinkedHashSet<>(); + + try { + if (cacheDirectory != null) { + if (log) { + LOGGER.debug("Using cache directory: {}", cacheDirectory); + } + System.setProperty("grape.root", cacheDirectory); + } + + Grape.setEnableAutoDownload(true); + + try (final GroovyClassLoader classLoader = new GroovyClassLoader()) { + + Map<String, Object> param = new HashMap<>(); + param.put("classLoader", classLoader); + param.put("group", groupId); + param.put("module", artifactId); + param.put("version", version); + // no need to download transitive dependencies as we only need to check the component itself + param.put("validate", false); + param.put("transitive", false); + + if (log) { + LOGGER.info("Downloading {}:{}:{}", groupId, artifactId, version); + } + Grape.grab(param); + + // the classloader can load content from the downloaded JAR + if (camelCatalog != null) { + scanCamelComponents(camelCatalog, classLoader, names); + } + } + + } catch (Exception e) { + if (log) { + LOGGER.warn("Error during add components from artifact {}:{}:{} due {}", groupId, artifactId, version, + e.getMessage(), e); + } + } + + return names; + } + + protected void scanCamelComponents(CamelCatalog camelCatalog, ClassLoader classLoader, Set<String> names) { + // is there any custom Camel components in this library? + Properties properties = loadComponentProperties(log, classLoader); + String components = (String) properties.get("components"); + if (components != null) { + String[] part = components.split("\\s"); + for (String scheme : part) { + if (!camelCatalog.findComponentNames().contains(scheme)) { + findClassName(camelCatalog, classLoader, names, scheme); + } + } + } + } + + private void findClassName(CamelCatalog camelCatalog, ClassLoader classLoader, Set<String> names, String scheme) { + // find the class name + String javaType = extractComponentJavaType(log, classLoader, scheme); + if (javaType != null) { + String json = loadComponentJSonSchema(log, classLoader, scheme); + if (json != null) { + if (log) { + LOGGER.info("Adding component: {}", scheme); + } + camelCatalog.addComponent(scheme, javaType, json); + names.add(scheme); + } + } + } + +} diff --git a/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenArtifactProvider.java b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenArtifactProvider.java new file mode 100644 index 00000000000..915395aba17 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenArtifactProvider.java @@ -0,0 +1,60 @@ +/* + * 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.camel.catalog.maven; + +import java.util.Set; + +import org.apache.camel.catalog.CamelCatalog; + +/** + * Provider which allows downloading artifact using Maven and add content to the {@link CamelCatalog}. + */ +public interface MavenArtifactProvider { + + /** + * Configures the directory for the download cache. + * <p/> + * The default folder is <tt>USER_HOME/.groovy/grape</tt> + * + * @param directory the directory. + */ + void setCacheDirectory(String directory); + + /** + * To add a 3rd party Maven repository. + * + * @param name the repository name + * @param url the repository url + */ + void addMavenRepository(String name, String url); + + /** + * Downloads the artifact using the Maven coordinates and scans the JAR for Camel components which will be added to + * the CamelCatalog. + * + * @param camelCatalog The Camel Catalog + * @param groupId Maven group id + * @param artifactId Maven artifact id + * @param version Maven version + * @return the names of the components that was added, or an empty set if none found or they already + * exists in the catalog + */ + Set<String> addArtifactToCatalog( + CamelCatalog camelCatalog, + String groupId, String artifactId, String version); + +} diff --git a/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenVersionManager.java b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenVersionManager.java new file mode 100644 index 00000000000..e41858f5ff9 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/MavenVersionManager.java @@ -0,0 +1,214 @@ +/* + * 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.camel.catalog.maven; + +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; + +import groovy.grape.Grape; +import groovy.lang.GroovyClassLoader; +import org.apache.camel.catalog.VersionManager; +import org.apache.ivy.util.url.URLHandlerRegistry; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A {@link VersionManager} that can load the resources using Maven to download needed artifacts from a local or remote + * Maven repository. + * <p/> + * This implementation uses Groovy Grape to download the Maven JARs. + */ +public class MavenVersionManager implements VersionManager, Closeable { + + private static final Logger LOGGER = LoggerFactory.getLogger(MavenVersionManager.class); + + private ClassLoader classLoader; + private final ClassLoader groovyClassLoader = new GroovyClassLoader(); + private final TimeoutHttpClientHandler httpClient = new TimeoutHttpClientHandler(); + private String version; + private String runtimeProviderVersion; + private String cacheDirectory; + private boolean log; + + @Override + public void setClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } + + /** + * Configures the directory for the download cache. + * <p/> + * The default folder is <tt>USER_HOME/.groovy/grape</tt> + * + * @param directory the directory. + */ + public void setCacheDirectory(String directory) { + this.cacheDirectory = directory; + } + + /** + * Sets whether to log errors and warnings to System.out. By default nothing is logged. + */ + public void setLog(boolean log) { + this.log = log; + } + + /** + * Sets the timeout in millis (http.socket.timeout) when downloading via http/https protocols. + * <p/> + * The default value is 10000 + */ + public void setHttpClientTimeout(int timeout) { + httpClient.setTimeout(timeout); + } + + /** + * To add a 3rd party Maven repository. + * + * @param name the repository name + * @param url the repository url + */ + public void addMavenRepository(String name, String url) { + Map<String, Object> repo = new HashMap<>(); + repo.put("name", name); + repo.put("root", url); + Grape.addResolver(repo); + } + + @Override + public String getLoadedVersion() { + return version; + } + + @Override + public boolean loadVersion(String version) { + try { + URLHandlerRegistry.setDefault(httpClient); + + if (cacheDirectory != null) { + System.setProperty("grape.root", cacheDirectory); + } + + Grape.setEnableAutoDownload(true); + + Map<String, Object> param = new HashMap<>(); + param.put("classLoader", groovyClassLoader); + param.put("group", "org.apache.camel"); + param.put("module", "camel-catalog"); + param.put("version", version); + + Grape.grab(param); + + this.version = version; + return true; + } catch (Exception e) { + if (log) { + LOGGER.warn("Cannot load version {} due {}", version, e.getMessage(), e); + } + return false; + } + } + + @Override + public String getRuntimeProviderLoadedVersion() { + return runtimeProviderVersion; + } + + @Override + public boolean loadRuntimeProviderVersion(String groupId, String artifactId, String version) { + try { + URLHandlerRegistry.setDefault(httpClient); + + Grape.setEnableAutoDownload(true); + + Map<String, Object> param = new HashMap<>(); + param.put("classLoader", groovyClassLoader); + param.put("group", groupId); + param.put("module", artifactId); + param.put("version", version); + + Grape.grab(param); + + this.runtimeProviderVersion = version; + return true; + } catch (Exception e) { + if (log) { + LOGGER.warn("Cannot load runtime provider version {} due {}", version, e.getMessage(), e); + } + return false; + } + } + + @Override + public InputStream getResourceAsStream(String name) { + InputStream is = null; + + if (runtimeProviderVersion != null) { + is = doGetResourceAsStream(name, runtimeProviderVersion); + } + if (is == null && version != null) { + is = doGetResourceAsStream(name, version); + } + if (classLoader != null && is == null) { + is = classLoader.getResourceAsStream(name); + } + if (is == null) { + is = MavenVersionManager.class.getClassLoader().getResourceAsStream(name); + } + if (is == null) { + is = groovyClassLoader.getResourceAsStream(name); + } + + return is; + } + + private InputStream doGetResourceAsStream(String name, String version) { + if (version == null) { + return null; + } + + try { + URL found = null; + Enumeration<URL> urls = groovyClassLoader.getResources(name); + while (urls.hasMoreElements()) { + URL url = urls.nextElement(); + if (url.getPath().contains(version)) { + found = url; + break; + } + } + if (found != null) { + return found.openStream(); + } + } catch (IOException e) { + if (log) { + LOGGER.warn("Cannot open resource {} and version {} due {}", name, version, e.getMessage(), e); + } + } + + return null; + } + + @Override + public void close() { + } +} diff --git a/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/TimeoutHttpClientHandler.java b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/TimeoutHttpClientHandler.java new file mode 100644 index 00000000000..cd1b743ed88 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/java/org/apache/camel/catalog/maven/TimeoutHttpClientHandler.java @@ -0,0 +1,72 @@ +/* + * 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.camel.catalog.maven; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; + +import org.apache.ivy.util.url.BasicURLHandler; +import org.apache.ivy.util.url.HttpClientHandler; + +/** + * A {@link HttpClientHandler} which uses HttpClient for downloading via http/https and have support for connection + * timeouts which otherwise is not supported by default in Apache Ivy. + */ +public class TimeoutHttpClientHandler extends HttpClientHandler { + + // use basic handler for non http/https as it can load from jar/file etc + private BasicURLHandler basic = new BasicURLHandler(); + + private int timeout = 10000; + + public int getTimeout() { + return timeout; + } + + /** + * Sets the timeout in millis (http.socket.timeout) when downloading via http/https protocols. + * <p/> + * The default value is 10000 + */ + public void setTimeout(int timeout) { + this.timeout = timeout; + } + + @Override + public URLInfo getURLInfo(URL url) { + // ensure we always use a timeout + String protocol = url.getProtocol(); + if ("http".equals(protocol) || "https".equals(protocol)) { + return super.getURLInfo(url, timeout); + } else { + // use basic for non http + return basic.getURLInfo(url, timeout); + } + } + + @Override + public InputStream openStream(URL url) throws IOException { + String protocol = url.getProtocol(); + if ("http".equals(protocol) || "https".equals(protocol)) { + return super.openStream(url); + } else { + // use basic for non http + return basic.openStream(url); + } + } +} diff --git a/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/LICENSE.txt b/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + diff --git a/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/NOTICE.txt b/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenArtifactProviderManualTest.java b/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenArtifactProviderManualTest.java new file mode 100644 index 00000000000..d52bdac2ae6 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenArtifactProviderManualTest.java @@ -0,0 +1,49 @@ +/* + * 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.camel.catalog.maven; + +import java.util.Set; + +import org.apache.camel.catalog.CamelCatalog; +import org.apache.camel.catalog.DefaultCamelCatalog; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@Disabled("Cannot run on CI servers so run manually") +public class MavenArtifactProviderManualTest { + + @Test + public void testAddComponent() { + CamelCatalog camelCatalog = new DefaultCamelCatalog(); + MavenArtifactProvider provider = new DefaultMavenArtifactProvider(); + provider.setCacheDirectory("target/cache"); + + int before = camelCatalog.findComponentNames().size(); + + Set<String> names = provider.addArtifactToCatalog(camelCatalog, "org.apache.camel", "dummy-component", + camelCatalog.getCatalogVersion()); + assertTrue(names.contains("dummy")); + + int after = camelCatalog.findComponentNames().size(); + + assertEquals(1, after - before, "Should find 1 new component"); + } + +} diff --git a/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenVersionManagerManualTest.java b/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenVersionManagerManualTest.java new file mode 100644 index 00000000000..93a82165ebc --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/test/java/org/apache/camel/catalog/maven/MavenVersionManagerManualTest.java @@ -0,0 +1,153 @@ +/* + * 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.camel.catalog.maven; + +import java.io.InputStream; +import java.util.List; + +import org.apache.camel.catalog.CamelCatalog; +import org.apache.camel.catalog.DefaultCamelCatalog; +import org.apache.camel.catalog.DefaultRuntimeProvider; +import org.apache.camel.catalog.impl.CatalogHelper; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@Disabled("Cannot run on CI servers so run manually") +public class MavenVersionManagerManualTest { + + private static final String COMPONENTS_CATALOG = "org/apache/camel/catalog/components.properties"; + + @Test + public void testLoadVersion() throws Exception { + MavenVersionManager manager = new MavenVersionManager(); + String current = manager.getLoadedVersion(); + assertNull(current); + + boolean loaded = manager.loadVersion("2.17.2"); + assertTrue(loaded); + + assertEquals("2.17.2", manager.getLoadedVersion()); + + InputStream is = manager.getResourceAsStream(COMPONENTS_CATALOG); + assertNotNull(is); + String text = CatalogHelper.loadText(is); + + // should not contain Camel 2.18 components + assertFalse(text.contains("servicenow")); + // but 2.17 components such + assertTrue(text.contains("nats")); + } + + @Test + public void testEndpointOptions217() { + CamelCatalog catalog = new DefaultCamelCatalog(false); + catalog.setVersionManager(new MavenVersionManager()); + catalog.loadVersion("2.17.1"); + + assertEquals("2.17.1", catalog.getLoadedVersion()); + + String json = catalog.componentJSonSchema("ahc"); + assertNotNull(json); + + // should have loaded the 2.17.1 version + assertTrue(json.contains("\"version\": \"2.17.1\"")); + + // should not contain Camel 2.18 option + assertFalse(json.contains("connectionClose")); + } + + @Test + public void testEndpointOptions218OrNewer() { + CamelCatalog catalog = new DefaultCamelCatalog(false); + catalog.setVersionManager(new MavenVersionManager()); + catalog.loadVersion("2.18.3"); + + String json = catalog.componentJSonSchema("ahc"); + assertNotNull(json); + + // should contain the Camel 2.18 option + assertTrue(json.contains("connectionClose")); + } + + @Test + public void testRuntimeProviderLoadVersion() { + CamelCatalog catalog = new DefaultCamelCatalog(false); + catalog.setVersionManager(new MavenVersionManager()); + catalog.setRuntimeProvider(new DefaultRuntimeProvider()); + + String version = "2.18.2"; + + boolean loaded = catalog.loadVersion(version); + assertTrue(loaded); + + loaded = catalog.loadRuntimeProviderVersion(catalog.getRuntimeProvider().getProviderGroupId(), + catalog.getRuntimeProvider().getProviderArtifactId(), version); + assertTrue(loaded); + + assertEquals(version, catalog.getLoadedVersion()); + assertEquals(version, catalog.getRuntimeProviderLoadedVersion()); + + List<String> names = catalog.findComponentNames(); + + assertTrue(names.contains("file")); + assertTrue(names.contains("ftp")); + assertTrue(names.contains("jms")); + } + + @Test + public void testRuntimeProviderLoadVersionWithCaching() { + CamelCatalog catalog = new DefaultCamelCatalog(true); + catalog.setVersionManager(new MavenVersionManager()); + catalog.setRuntimeProvider(new DefaultRuntimeProvider()); + + String version = "2.18.2"; + + boolean loaded = catalog.loadVersion(version); + assertTrue(loaded); + + loaded = catalog.loadRuntimeProviderVersion(catalog.getRuntimeProvider().getProviderGroupId(), + catalog.getRuntimeProvider().getProviderArtifactId(), version); + assertTrue(loaded); + + assertEquals(version, catalog.getLoadedVersion()); + assertEquals(version, catalog.getRuntimeProviderLoadedVersion()); + + List<String> names = catalog.findComponentNames(); + + assertTrue(names.contains("file")); + assertTrue(names.contains("ftp")); + assertTrue(names.contains("jms")); + } + + @Test + public void testLoadUnknownVersion() { + MavenVersionManager manager = new MavenVersionManager(); + String current = manager.getLoadedVersion(); + assertNull(current); + + // version 2.99 does not exists and cannot be loaded + boolean loaded = manager.loadVersion("2.99"); + assertFalse(loaded); + } + +} diff --git a/catalog/camel-catalog-maven-grape/src/test/resources/log4j2.properties b/catalog/camel-catalog-maven-grape/src/test/resources/log4j2.properties new file mode 100644 index 00000000000..490e3b34e24 --- /dev/null +++ b/catalog/camel-catalog-maven-grape/src/test/resources/log4j2.properties @@ -0,0 +1,28 @@ +## --------------------------------------------------------------------------- +## 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. +## --------------------------------------------------------------------------- + +appender.file.type = File +appender.file.name = file +appender.file.fileName = target/camel-catalog-maven-test.log +appender.file.layout.type = PatternLayout +appender.file.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +appender.out.type = Console +appender.out.name = out +appender.out.layout.type = PatternLayout +appender.out.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +rootLogger.level = INFO +rootLogger.appenderRef.out.ref = out diff --git a/catalog/pom.xml b/catalog/pom.xml index f8643d0992e..38adeffa99b 100644 --- a/catalog/pom.xml +++ b/catalog/pom.xml @@ -43,6 +43,7 @@ <module>camel-catalog-console</module> <module>camel-catalog-lucene</module> <module>camel-catalog-maven</module> + <module>camel-catalog-maven-grape</module> <!-- tooling that depends on catalog --> <module>camel-route-parser</module> <module>camel-csimple-maven-plugin</module>
