Convert PluginPropertiesExtension Groovy to Java (#39605)

This commit is contained in:
Rafiullah Hamedy 2019-06-13 01:14:34 -04:00 committed by Alpar Torok
parent f70141c862
commit a1b8d48f17
3 changed files with 209 additions and 94 deletions

View File

@ -1,94 +0,0 @@
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.elasticsearch.gradle.plugin
import org.gradle.api.Project
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
/**
* A container for plugin properties that will be written to the plugin descriptor, for easy
* manipulation in the gradle DSL.
*/
class PluginPropertiesExtension {
@Input
String name
@Input
String version
@Input
String description
@Input
String classname
/** Other plugins this plugin extends through SPI */
@Input
List<String> extendedPlugins = []
@Input
boolean hasNativeController = false
/** Indicates whether the plugin jar should be made available for the transport client. */
@Input
boolean hasClientJar = false
/** True if the plugin requires the elasticsearch keystore to exist, false otherwise. */
@Input
boolean requiresKeystore = false
/** A license file that should be included in the built plugin zip. */
private File licenseFile = null
/**
* A notice file that should be included in the built plugin zip. This will be
* extended with notices from the {@code licenses/} directory.
*/
private File noticeFile = null
Project project = null
PluginPropertiesExtension(Project project) {
name = project.name
version = project.version
this.project = project
}
@InputFile
File getLicenseFile() {
return licenseFile
}
void setLicenseFile(File licenseFile) {
project.ext.licenseFile = licenseFile
this.licenseFile = licenseFile
}
@InputFile
File getNoticeFile() {
return noticeFile
}
void setNoticeFile(File noticeFile) {
project.ext.noticeFile = noticeFile
this.noticeFile = noticeFile
}
}

View File

@ -0,0 +1,151 @@
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.elasticsearch.gradle.plugin;
import org.gradle.api.Project;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
/**
* A container for plugin properties that will be written to the plugin descriptor, for easy
* manipulation in the gradle DSL.
*/
public class PluginPropertiesExtension {
private String name;
private String version;
private String description;
private String classname;
/** Other plugins this plugin extends through SPI */
private List<String> extendedPlugins = new ArrayList<>();
private boolean hasNativeController;
/** True if the plugin requires the elasticsearch keystore to exist, false otherwise. */
private boolean requiresKeystore;
/** A license file that should be included in the built plugin zip. */
private File licenseFile;
private boolean hasClientJar = false;
/**
* A notice file that should be included in the built plugin zip. This will be
* extended with notices from the {@code licenses/} directory.
*/
private File noticeFile;
private final Project project;
public PluginPropertiesExtension(Project project) {
this.project = project;
}
public String getName() {
return name == null ? project.getName() : name;
}
public void setName(String name) {
this.name = name;
}
public String getVersion() {
return version == null ? project.getVersion().toString() : version;
}
public void setVersion(String version) {
this.version = version;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public String getClassname() {
return classname;
}
public void setClassname(String classname) {
this.classname = classname;
}
public List<String> getExtendedPlugins() {
return this.extendedPlugins;
}
public boolean isHasNativeController() {
return hasNativeController;
}
public void setHasNativeController(boolean hasNativeController) {
this.hasNativeController = hasNativeController;
}
public boolean isRequiresKeystore() {
return requiresKeystore;
}
public void setRequiresKeystore(boolean requiresKeystore) {
this.requiresKeystore = requiresKeystore;
}
public File getLicenseFile() {
return licenseFile;
}
public void setLicenseFile(File licenseFile) {
this.project.getExtensions().getExtraProperties().set("licenseFile", licenseFile);
this.licenseFile = licenseFile;
}
public File getNoticeFile() {
return noticeFile;
}
public void setNoticeFile(File noticeFile) {
this.project.getExtensions().getExtraProperties().set("noticeFile", noticeFile);
this.noticeFile = noticeFile;
}
public Project getProject() {
return project;
}
public void setExtendedPlugins(List<String> extendedPlugins) {
this.extendedPlugins = extendedPlugins;
}
public boolean isHasClientJar() {
return hasClientJar;
}
public void setHasClientJar(boolean hasClientJar) {
this.hasClientJar = hasClientJar;
}
}

View File

@ -0,0 +1,58 @@
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch 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.elasticsearch.gradle.plugin;
import org.elasticsearch.gradle.test.GradleUnitTestCase;
import org.gradle.api.Project;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.testfixtures.ProjectBuilder;
public class PluginPropertiesExtensionTests extends GradleUnitTestCase {
public void testCreatingPluginPropertiesExtensionWithNameAndVersion() {
String projectName = "Test";
String projectVersion = "5.0";
PluginPropertiesExtension pluginPropertiesExtension =
new PluginPropertiesExtension(this.createProject(projectName, projectVersion));
assertEquals(projectName, pluginPropertiesExtension.getName());
assertEquals(projectVersion, pluginPropertiesExtension.getVersion());
}
public void testCreatingPluginPropertiesExtensionWithNameWithoutVersion() {
String projectName = "Test";
PluginPropertiesExtension pluginPropertiesExtension =
new PluginPropertiesExtension(this.createProject(projectName, null));
assertEquals(projectName, pluginPropertiesExtension.getName());
assertEquals("unspecified", pluginPropertiesExtension.getVersion());
}
private Project createProject(String projectName, String version) {
Project project = ProjectBuilder.builder().withName(projectName).build();
project.setVersion(version);
project.getPlugins().apply(JavaPlugin.class);
return project;
}
}