Add tests for Bash programmable completion (#998)

* Add tests for Bash completion
* Fix broken uname stub setup
* Let test task depend on prepareContrib
* Quote array expansion

Author: Oliver Weiler

contrib/completion/bash/sdk

@@ -1,11 +1,12 @@
 #!/usr/bin/bash
 
 _sdk() {
-	local -r before_previous_word="${COMP_WORDS[COMP_CWORD - 2]}"
 	local -r previous_word="${COMP_WORDS[COMP_CWORD - 1]}"
 	local -r current_word="${COMP_WORDS[COMP_CWORD]}"
 
 	if ((COMP_CWORD == 3)); then
+		local -r before_previous_word="${COMP_WORDS[COMP_CWORD - 2]}"
+
 		__sdkman_complete_candidate_version "$before_previous_word" "$previous_word" "$current_word"
 
 		return

gradle/archive.gradle

@@ -45,5 +45,5 @@ tasks.assemble.configure {
 }
 
 tasks.test.configure {
-	dependsOn(prepareBin, prepareScripts)
+	dependsOn(prepareBin, prepareScripts, prepareContrib)
 }

src/test/groovy/sdkman/env/SdkmanBashEnvBuilder.groovy

@@ -10,6 +10,7 @@ class SdkmanBashEnvBuilder {
 	final BUILD_STAGE_DIR = "build/stage/sdkman-latest+hashme"
 	final BUILD_BIN_DIR = "$BUILD_STAGE_DIR/bin"
 	final BUILD_SRC_DIR = "$BUILD_STAGE_DIR/src"
+	final BUILD_COMPLETION_DIR = "$BUILD_STAGE_DIR/contrib/completion/bash"
 
 	//mandatory fields
 	private final File baseFolder
@@ -33,7 +34,7 @@ class SdkmanBashEnvBuilder {
 	]
 
 	File sdkmanDir, sdkmanBinDir, sdkmanVarDir, sdkmanSrcDir, sdkmanEtcDir, sdkmanExtDir, sdkmanArchivesDir,
-		 sdkmanTmpDir, sdkmanCandidatesDir, sdkmanMetadataDir
+		 sdkmanTmpDir, sdkmanCandidatesDir, sdkmanMetadataDir, sdkmanContribDir
 
 	static SdkmanBashEnvBuilder create(File baseFolder) {
 		new SdkmanBashEnvBuilder(baseFolder)
@@ -114,6 +115,7 @@ class SdkmanBashEnvBuilder {
 		sdkmanTmpDir = prepareDirectory(sdkmanDir, "tmp")
 		sdkmanCandidatesDir = prepareDirectory(sdkmanDir, "candidates")
 		sdkmanMetadataDir = prepareDirectory(sdkmanVarDir, "metadata")
+		sdkmanContribDir = prepareDirectory(sdkmanDir, "contrib")
 
 		curlStub.map { it.build() }
 		unameStub.map { it.build() }
@@ -126,6 +128,7 @@ class SdkmanBashEnvBuilder {
 
 		primeInitScript(sdkmanBinDir)
 		primeModuleScripts(sdkmanSrcDir)
+		primeBashCompletionScript(sdkmanContribDir)
 
 		def env = [
 				SDKMAN_DIR           : sdkmanDir.absolutePath,
@@ -194,6 +197,21 @@ class SdkmanBashEnvBuilder {
 		destInitScript
 	}
 
+	private primeBashCompletionScript(File targetFolder) {
+		def sourceCompletionScript = new File(BUILD_COMPLETION_DIR, 'sdk')
+
+		if (!sourceCompletionScript.exists())
+			throw new IllegalStateException("sdk has not been prepared for consumption.")
+
+		new FileTreeBuilder(targetFolder).with {
+			completion {
+				bash {
+					sdk(sourceCompletionScript.text)
+				}
+			}			
+		}
+	}
+
 	private primeModuleScripts(File targetFolder) {
 		for (f in new File(BUILD_SRC_DIR).listFiles()) {
 			if (!(f.name in ['selfupdate.sh', 'install.sh', 'sdkman-init.sh'])) {

src/test/groovy/sdkman/specs/CompletionSpec.groovy

@@ -0,0 +1,73 @@
+package sdkman.specs
+
+import sdkman.support.SdkmanEnvSpecification
+
+class CompletionSpec extends SdkmanEnvSpecification {
+	static final String CANDIDATES_API = "http://localhost:8080/2"
+
+	static final String BROADCAST_API_LATEST_ID_ENDPOINT = "$CANDIDATES_API/broadcast/latest/id"
+	static final String CANDIDATES_ALL_ENDPOINT = "$CANDIDATES_API/candidates/all"
+
+	def "should complete the list of commands"() {
+		given:
+		bash = sdkmanBashEnvBuilder
+				.withVersionCache("x.y.z")
+				.withConfiguration("sdkman_auto_complete", "true")
+				.build()
+
+		bash.start()
+		bash.execute("source $bootstrapScript")
+
+		when:
+		bash.execute("COMP_CWORD=1; COMP_WORDS=(sdk); _sdk")
+		bash.execute('echo "\${COMPREPLY[@]}"')
+
+		then:
+		bash.output.contains("install uninstall list use config default home env current upgrade version broadcast help offline selfupdate update flush")
+	}
+
+	def "should complete the list of candidates"() {
+		given:
+		curlStub.primeWith(BROADCAST_API_LATEST_ID_ENDPOINT, "echo dbfb025be9f97fda2052b5febcca0155")
+				.primeWith(CANDIDATES_ALL_ENDPOINT, "echo java,groovy")
+
+		bash = sdkmanBashEnvBuilder
+				.withVersionCache("x.y.z")
+				.withConfiguration("sdkman_auto_complete", "true")
+				.build()
+
+		bash.start()
+		bash.execute("source $bootstrapScript")
+
+		when:
+		bash.execute("COMP_CWORD=2; COMP_WORDS=(sdk install); _sdk")
+		bash.execute("echo \${COMPREPLY[@]}")
+
+		then:
+		bash.output.contains("java groovy")
+	}
+
+	def "should complete the list of Java versions"() {
+		given:
+		curlStub.primeWith(BROADCAST_API_LATEST_ID_ENDPOINT, "echo dbfb025be9f97fda2052b5febcca0155")
+				.primeWith("$CANDIDATES_API/candidates/java/darwinx64/versions/all", "echo 16.0.1.hs-adpt,17.0.0-tem")
+
+		unameStub.forKernel("Darwin").forMachine("x86_64")
+
+		bash = sdkmanBashEnvBuilder
+				.withVersionCache("x.y.z")
+				.withConfiguration("sdkman_auto_complete", "true")
+				.withUnameStub(unameStub)
+				.build()
+
+		bash.start()
+		bash.execute("source $bootstrapScript")
+
+		when:
+		bash.execute("COMP_CWORD=3; COMP_WORDS=(sdk install java); _sdk")
+		bash.execute("echo \${COMPREPLY[@]}")
+
+		then:
+		bash.output.contains("16.0.1.hs-adpt 17.0.0-tem")
+	}
+}