|
| 1 | +/* |
| 2 | + * Licensed to Elasticsearch under one or more contributor |
| 3 | + * license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright |
| 5 | + * ownership. Elasticsearch licenses this file to you under |
| 6 | + * the Apache License, Version 2.0 (the "License"); you may |
| 7 | + * not use this file except in compliance with the License. |
| 8 | + * You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | +package org.elasticsearch.gradle.test.rest; |
| 20 | + |
| 21 | +import org.elasticsearch.gradle.VersionProperties; |
| 22 | +import org.elasticsearch.gradle.info.BuildParams; |
| 23 | +import org.elasticsearch.gradle.tool.Boilerplate; |
| 24 | +import org.gradle.api.DefaultTask; |
| 25 | +import org.gradle.api.Project; |
| 26 | +import org.gradle.api.artifacts.Configuration; |
| 27 | +import org.gradle.api.file.ConfigurableFileCollection; |
| 28 | +import org.gradle.api.file.FileTree; |
| 29 | +import org.gradle.api.provider.ListProperty; |
| 30 | +import org.gradle.api.tasks.Input; |
| 31 | +import org.gradle.api.tasks.InputFiles; |
| 32 | +import org.gradle.api.tasks.OutputDirectory; |
| 33 | +import org.gradle.api.tasks.SkipWhenEmpty; |
| 34 | +import org.gradle.api.tasks.SourceSet; |
| 35 | +import org.gradle.api.tasks.TaskAction; |
| 36 | +import org.gradle.api.tasks.util.PatternFilterable; |
| 37 | +import org.gradle.api.tasks.util.PatternSet; |
| 38 | +import org.gradle.internal.Factory; |
| 39 | + |
| 40 | +import javax.inject.Inject; |
| 41 | +import java.io.File; |
| 42 | +import java.io.IOException; |
| 43 | +import java.nio.file.Files; |
| 44 | +import java.util.Set; |
| 45 | +import java.util.stream.Collectors; |
| 46 | + |
| 47 | +/** |
| 48 | + * Copies the files needed for the Rest YAML specs to the current projects test resources output directory. |
| 49 | + * This is intended to be be used from {@link RestResourcesPlugin} since the plugin wires up the needed |
| 50 | + * configurations and custom extensions. |
| 51 | + * @see RestResourcesPlugin |
| 52 | + */ |
| 53 | +public class CopyRestApiTask extends DefaultTask { |
| 54 | + private static final String COPY_TO = "rest-api-spec/api"; |
| 55 | + final ListProperty<String> includeCore = getProject().getObjects().listProperty(String.class); |
| 56 | + final ListProperty<String> includeXpack = getProject().getObjects().listProperty(String.class); |
| 57 | + |
| 58 | + Configuration coreConfig; |
| 59 | + Configuration xpackConfig; |
| 60 | + |
| 61 | + private final PatternFilterable corePatternSet; |
| 62 | + private final PatternFilterable xpackPatternSet; |
| 63 | + |
| 64 | + public CopyRestApiTask() { |
| 65 | + corePatternSet = getPatternSetFactory().create(); |
| 66 | + xpackPatternSet = getPatternSetFactory().create(); |
| 67 | + } |
| 68 | + |
| 69 | + @Inject |
| 70 | + protected Factory<PatternSet> getPatternSetFactory() { |
| 71 | + throw new UnsupportedOperationException(); |
| 72 | + } |
| 73 | + |
| 74 | + @Input |
| 75 | + public ListProperty<String> getIncludeCore() { |
| 76 | + return includeCore; |
| 77 | + } |
| 78 | + |
| 79 | + @Input |
| 80 | + public ListProperty<String> getIncludeXpack() { |
| 81 | + return includeXpack; |
| 82 | + } |
| 83 | + |
| 84 | + @SkipWhenEmpty |
| 85 | + @InputFiles |
| 86 | + public FileTree getInputDir() { |
| 87 | + xpackPatternSet.setIncludes(includeXpack.get().stream().map(prefix -> prefix + "*/**").collect(Collectors.toList())); |
| 88 | + ConfigurableFileCollection fileCollection = getProject().files(xpackConfig.getAsFileTree().matching(xpackPatternSet)); |
| 89 | + if (BuildParams.isInternal()) { |
| 90 | + corePatternSet.setIncludes(includeCore.get().stream().map(prefix -> prefix + "*/**").collect(Collectors.toList())); |
| 91 | + fileCollection.plus(coreConfig.getAsFileTree().matching(corePatternSet)); |
| 92 | + } else { |
| 93 | + fileCollection.plus(coreConfig); |
| 94 | + } |
| 95 | + // if project has rest tests or the includes are explicitly configured execute the task, else NO-SOURCE due to the null input |
| 96 | + return projectHasYamlRestTests() || includeCore.get().isEmpty() == false || includeXpack.get().isEmpty() == false |
| 97 | + ? fileCollection.getAsFileTree() |
| 98 | + : null; |
| 99 | + } |
| 100 | + |
| 101 | + @OutputDirectory |
| 102 | + public File getOutputDir() { |
| 103 | + return new File(getTestSourceSet().getOutput().getResourcesDir(), COPY_TO); |
| 104 | + } |
| 105 | + |
| 106 | + @TaskAction |
| 107 | + void copy() { |
| 108 | + Project project = getProject(); |
| 109 | + // always copy the core specs if the task executes |
| 110 | + if (BuildParams.isInternal()) { |
| 111 | + getLogger().debug("Rest specs for project [{}] will be copied to the test resources.", project.getPath()); |
| 112 | + project.copy(c -> { |
| 113 | + c.from(coreConfig.getSingleFile()); |
| 114 | + c.into(getOutputDir()); |
| 115 | + c.include(corePatternSet.getIncludes()); |
| 116 | + }); |
| 117 | + } else { |
| 118 | + getLogger().debug( |
| 119 | + "Rest specs for project [{}] will be copied to the test resources from the published jar (version: [{}]).", |
| 120 | + project.getPath(), |
| 121 | + VersionProperties.getElasticsearch() |
| 122 | + ); |
| 123 | + project.copy(c -> { |
| 124 | + c.from(project.zipTree(coreConfig.getSingleFile())); |
| 125 | + c.into(getTestSourceSet().getOutput().getResourcesDir()); // this ends up as the same dir as outputDir |
| 126 | + c.include(includeCore.get().stream().map(prefix -> COPY_TO + "/" + prefix + "*/**").collect(Collectors.toList())); |
| 127 | + }); |
| 128 | + } |
| 129 | + // only copy x-pack specs if explicitly instructed |
| 130 | + if (includeXpack.get().isEmpty() == false) { |
| 131 | + getLogger().debug("X-pack rest specs for project [{}] will be copied to the test resources.", project.getPath()); |
| 132 | + project.copy(c -> { |
| 133 | + c.from(xpackConfig.getSingleFile()); |
| 134 | + c.into(getOutputDir()); |
| 135 | + c.include(xpackPatternSet.getIncludes()); |
| 136 | + }); |
| 137 | + } |
| 138 | + } |
| 139 | + |
| 140 | + /** |
| 141 | + * Returns true if any files with a .yml extension exist the test resources rest-api-spec/test directory (from source or output dir) |
| 142 | + */ |
| 143 | + private boolean projectHasYamlRestTests() { |
| 144 | + File testSourceResourceDir = getTestSourceResourceDir(); |
| 145 | + File testOutputResourceDir = getTestOutputResourceDir(); // check output for cases where tests are copied programmatically |
| 146 | + |
| 147 | + if (testSourceResourceDir == null && testOutputResourceDir == null) { |
| 148 | + return false; |
| 149 | + } |
| 150 | + try { |
| 151 | + if (testSourceResourceDir != null) { |
| 152 | + return new File(testSourceResourceDir, "rest-api-spec/test").exists() == false |
| 153 | + || Files.walk(testSourceResourceDir.toPath().resolve("rest-api-spec/test")) |
| 154 | + .anyMatch(p -> p.getFileName().toString().endsWith("yml")); |
| 155 | + } |
| 156 | + if (testOutputResourceDir != null) { |
| 157 | + return new File(testOutputResourceDir, "rest-api-spec/test").exists() == false |
| 158 | + || Files.walk(testOutputResourceDir.toPath().resolve("rest-api-spec/test")) |
| 159 | + .anyMatch(p -> p.getFileName().toString().endsWith("yml")); |
| 160 | + } |
| 161 | + } catch (IOException e) { |
| 162 | + throw new IllegalStateException(String.format("Error determining if this project [%s] has rest tests.", getProject()), e); |
| 163 | + } |
| 164 | + return false; |
| 165 | + } |
| 166 | + |
| 167 | + private File getTestSourceResourceDir() { |
| 168 | + SourceSet testSources = getTestSourceSet(); |
| 169 | + if (testSources == null) { |
| 170 | + return null; |
| 171 | + } |
| 172 | + Set<File> resourceDir = testSources.getResources() |
| 173 | + .getSrcDirs() |
| 174 | + .stream() |
| 175 | + .filter(f -> f.isDirectory() && f.getParentFile().getName().equals("test") && f.getName().equals("resources")) |
| 176 | + .collect(Collectors.toSet()); |
| 177 | + assert resourceDir.size() <= 1; |
| 178 | + if (resourceDir.size() == 0) { |
| 179 | + return null; |
| 180 | + } |
| 181 | + return resourceDir.iterator().next(); |
| 182 | + } |
| 183 | + |
| 184 | + private File getTestOutputResourceDir() { |
| 185 | + SourceSet testSources = getTestSourceSet(); |
| 186 | + if (testSources == null) { |
| 187 | + return null; |
| 188 | + } |
| 189 | + return testSources.getOutput().getResourcesDir(); |
| 190 | + } |
| 191 | + |
| 192 | + private SourceSet getTestSourceSet() { |
| 193 | + return Boilerplate.getJavaSourceSets(getProject()).findByName("test"); |
| 194 | + } |
| 195 | +} |
0 commit comments