forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sense for VirtualBox and $HOME when deciding to turn on vagrant testi…
…ng. (elastic#24636) We're using Vagrant in more places now than before. This commit includes a plugin that verifies the Vagrant and Virtualbox installations for projects that depend on them. This shared code should fix up the errors we've seen from CI builds relating to the new Kerberos fixture.
- Loading branch information
Showing
5 changed files
with
153 additions
and
82 deletions.
There are no files selected for viewing
127 changes: 127 additions & 0 deletions
127
buildSrc/src/main/groovy/org/elasticsearch/gradle/vagrant/VagrantSupportPlugin.groovy
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,127 @@ | ||
| package org.elasticsearch.gradle.vagrant | ||
|
|
||
| import org.gradle.api.GradleException | ||
| import org.gradle.api.InvalidUserDataException | ||
| import org.gradle.api.Plugin | ||
| import org.gradle.api.Project | ||
| import org.gradle.process.ExecResult | ||
| import org.gradle.process.internal.ExecException | ||
|
|
||
| /** | ||
| * Global configuration for if Vagrant tasks are supported in this | ||
| * build environment. | ||
| */ | ||
| class VagrantSupportPlugin implements Plugin<Project> { | ||
|
|
||
| @Override | ||
| void apply(Project project) { | ||
| if (project.rootProject.ext.has('vagrantEnvChecksDone') == false) { | ||
| Map vagrantInstallation = getVagrantInstallation(project) | ||
| Map virtualBoxInstallation = getVirtualBoxInstallation(project) | ||
|
|
||
| project.rootProject.ext.vagrantInstallation = vagrantInstallation | ||
| project.rootProject.ext.virtualBoxInstallation = virtualBoxInstallation | ||
| project.rootProject.ext.vagrantSupported = vagrantInstallation.supported && virtualBoxInstallation.supported | ||
| project.rootProject.ext.vagrantEnvChecksDone = true | ||
|
|
||
| // Finding that HOME needs to be set when performing vagrant updates | ||
| String homeLocation = System.getenv("HOME") | ||
| if (project.rootProject.ext.vagrantSupported && homeLocation == null) { | ||
| throw new GradleException("Could not locate \$HOME environment variable. Vagrant is enabled " + | ||
| "and requires \$HOME to be set to function properly.") | ||
| } | ||
| } | ||
|
|
||
| addVerifyInstallationTasks(project) | ||
| } | ||
|
|
||
| private Map getVagrantInstallation(Project project) { | ||
| try { | ||
| ByteArrayOutputStream pipe = new ByteArrayOutputStream() | ||
| ExecResult runResult = project.exec { | ||
| commandLine 'vagrant', '--version' | ||
| standardOutput pipe | ||
| ignoreExitValue true | ||
| } | ||
| String version = pipe.toString().trim() | ||
| if (runResult.exitValue == 0) { | ||
| if (version ==~ /Vagrant 1\.(8\.[6-9]|9\.[0-9])+/) { | ||
| return [ 'supported' : true ] | ||
| } else { | ||
| return [ 'supported' : false, | ||
| 'info' : "Illegal version of vagrant [${version}]. Need [Vagrant 1.8.6+]" ] | ||
| } | ||
| } else { | ||
| return [ 'supported' : false, | ||
| 'info' : "Could not read installed vagrant version:\n" + version ] | ||
| } | ||
| } catch (ExecException e) { | ||
| // Exec still throws this if it cannot find the command, regardless if ignoreExitValue is set. | ||
| // Swallow error. Vagrant isn't installed. Don't halt the build here. | ||
| return [ 'supported' : false, 'info' : "Could not find vagrant: " + e.message ] | ||
| } | ||
| } | ||
|
|
||
| private Map getVirtualBoxInstallation(Project project) { | ||
| try { | ||
| ByteArrayOutputStream pipe = new ByteArrayOutputStream() | ||
| ExecResult runResult = project.exec { | ||
| commandLine 'vboxmanage', '--version' | ||
| standardOutput = pipe | ||
| ignoreExitValue true | ||
| } | ||
| String version = pipe.toString().trim() | ||
| if (runResult.exitValue == 0) { | ||
| try { | ||
| String[] versions = version.split('\\.') | ||
| int major = Integer.parseInt(versions[0]) | ||
| int minor = Integer.parseInt(versions[1]) | ||
| if ((major < 5) || (major == 5 && minor < 1)) { | ||
| return [ 'supported' : false, | ||
| 'info' : "Illegal version of virtualbox [${version}]. Need [5.1+]" ] | ||
| } else { | ||
| return [ 'supported' : true ] | ||
| } | ||
| } catch (NumberFormatException | ArrayIndexOutOfBoundsException e) { | ||
| return [ 'supported' : false, | ||
| 'info' : "Unable to parse version of virtualbox [${version}]. Required [5.1+]" ] | ||
| } | ||
| } else { | ||
| return [ 'supported': false, 'info': "Could not read installed virtualbox version:\n" + version ] | ||
| } | ||
| } catch (ExecException e) { | ||
| // Exec still throws this if it cannot find the command, regardless if ignoreExitValue is set. | ||
| // Swallow error. VirtualBox isn't installed. Don't halt the build here. | ||
| return [ 'supported' : false, 'info' : "Could not find virtualbox: " + e.message ] | ||
| } | ||
| } | ||
|
|
||
| private void addVerifyInstallationTasks(Project project) { | ||
| createCheckVagrantVersionTask(project) | ||
| createCheckVirtualBoxVersionTask(project) | ||
| } | ||
|
|
||
| private void createCheckVagrantVersionTask(Project project) { | ||
| project.tasks.create('vagrantCheckVersion') { | ||
| description 'Check the Vagrant version' | ||
| group 'Verification' | ||
| doLast { | ||
| if (project.rootProject.vagrantInstallation.supported == false) { | ||
| throw new InvalidUserDataException(project.rootProject.vagrantInstallation.info) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void createCheckVirtualBoxVersionTask(Project project) { | ||
| project.tasks.create('virtualboxCheckVersion') { | ||
| description 'Check the Virtualbox version' | ||
| group 'Verification' | ||
| doLast { | ||
| if (project.rootProject.virtualBoxInstallation.supported == false) { | ||
| throw new InvalidUserDataException(project.rootProject.virtualBoxInstallation.info) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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
1 change: 1 addition & 0 deletions
1
buildSrc/src/main/resources/META-INF/gradle-plugins/elasticsearch.vagrantsupport.properties
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 @@ | ||
| implementation-class=org.elasticsearch.gradle.vagrant.VagrantSupportPlugin |
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