Skip to content

Commit

Permalink
Ensured all missing Kolin compiler arguments are handled
Browse files Browse the repository at this point in the history
  • Loading branch information
ethauvin committed May 29, 2024
1 parent b4c8952 commit 1623b90
Show file tree
Hide file tree
Showing 7 changed files with 197 additions and 33 deletions.
11 changes: 9 additions & 2 deletions scripts/checkcliargs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@ new=/tmp/checkcliargs-new
old=/tmp/checkcliargs-old

java -cp "lib/compile/*" $main -h >$new
java -cp "/examples/lib/bld*" $main -h >$old
java -cp "examples/lib/bld/*" $main -h >$old

diff $old $new

java -cp "lib/compile/*" $main -sourceSet -h >$new
java -cp "/examples/lib/bld*" $main -sourceSet -h >$old
java -cp "examples/lib/bld/*" $main -sourceSet -h >$old

diff $old $new

main=org.jetbrains.kotlin.cli.jvm.K2JVMCompiler

java -cp "lib/compile/*" $main -h 2>$new
java -cp "examples/lib/bld/*" $main -h 2>$old

diff $old $new

Expand Down
4 changes: 4 additions & 0 deletions scripts/cliargs.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#!/bin/bash

java -cp "lib/compile/*" org.jetbrains.kotlin.cli.jvm.K2JVMCompiler -h 2> >(grep "^ ") |\
sed -e "s/^ //" -e "s/ .*//" -e "s/<.*//" -e '/-help/d' -e '/-version/d' -e '/^$/d'|\
sort > "src/test/resources/kotlinc-args.txt"

main=org.jetbrains.dokka.MainKt

java -cp "lib/compile/*" $main -h |\
Expand Down
20 changes: 10 additions & 10 deletions src/bld/java/rife/bld/extension/CompileKotlinOperationBuild.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public CompileKotlinOperationBuild() {
version = version(0, 9, 8);

javaRelease = 17;

downloadSources = true;
autoDownloadPurge = true;
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES);
Expand Down Expand Up @@ -98,15 +98,6 @@ public static void main(String[] args) {
new CompileKotlinOperationBuild().start(args);
}

@Override
public void test() throws Exception {
new ExecOperation()
.fromProject(this)
.command("scripts/cliargs.sh")
.execute();
super.test();
}

@BuildCommand(summary = "Runs PMD analysis")
public void pmd() {
new PmdOperation()
Expand All @@ -115,4 +106,13 @@ public void pmd() {
.ruleSets("config/pmd.xml")
.execute();
}

@Override
public void test() throws Exception {
new ExecOperation()
.fromProject(this)
.command("scripts/cliargs.sh")
.execute();
super.test();
}
}
78 changes: 76 additions & 2 deletions src/main/java/rife/bld/extension/CompileKotlinOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,16 @@
* @since 1.0
*/
public class CompileKotlinOptions {
private final List<String> advancedOptions_ = new ArrayList<>();
private final List<String> argFile_ = new ArrayList<>();
private final List<String> classpath_ = new ArrayList<>();
private final List<String> jvmOptions_ = new ArrayList<>();
private final List<String> optIn_ = new ArrayList<>();
private final List<String> options_ = new ArrayList<>();
private final List<String> plugin_ = new ArrayList<>();
private final List<String> scriptTemplates_ = new ArrayList<>();
private String apiVersion_;
private String expression_;
private boolean includeRuntime_;
private boolean javaParameters_;
private String jdkHome_;
Expand All @@ -55,6 +58,28 @@ public class CompileKotlinOptions {
private boolean verbose_;
private boolean wError_;

/**
* Specify advanced compiler options.
*
* @param options one or more advanced options
* @return this operation instance
*/
public CompileKotlinOptions advancedOptions(String... options) {
Collections.addAll(advancedOptions_, options);
return this;
}

/**
* Specify advanced compiler options.
*
* @param options list of compiler options
* @return this operation instance
*/
public CompileKotlinOptions advancedOptions(Collection<String> options) {
advancedOptions_.addAll(options);
return this;
}

/**
* Allow using declarations only from the specified version of Kotlin bundled libraries.
*
Expand Down Expand Up @@ -120,7 +145,7 @@ public CompileKotlinOptions argFile(Collection<String> files) {
public List<String> args() {
var args = new ArrayList<String>();

// api-isNotBlankversion
// api-version
if (isNotBlank(apiVersion_)) {
args.add("-api-version");
args.add(apiVersion_);
Expand All @@ -137,6 +162,12 @@ public List<String> args() {
args.add(String.join(File.pathSeparator, classpath_));
}

// expression
if (isNotBlank(expression_)) {
args.add("-expression");
args.add(expression_);
}

// java-parameters
if (javaParameters_) {
args.add("-java-parameters");
Expand Down Expand Up @@ -164,6 +195,11 @@ public List<String> args() {
args.add("-Xjdk-release=" + jdkRelease_);
}

// JVM options
if (!jvmOptions_.isEmpty()) {
jvmOptions_.forEach(s -> args.add("-J" + s));
}

// kotlin-home
if (isNotBlank(kotlinHome_)) {
args.add("-kotlin-home");
Expand Down Expand Up @@ -199,7 +235,7 @@ public List<String> args() {

// no-warn
if (noWarn_) {
args.add("-no-warn");
args.add("-nowarn");
}

// opt-in
Expand Down Expand Up @@ -246,6 +282,11 @@ public List<String> args() {
args.add("-Werror");
}

// advanced option (X)
if (!advancedOptions_.isEmpty()) {
advancedOptions_.forEach(it -> args.add("-X" + it));
}

return args;
}

Expand Down Expand Up @@ -275,6 +316,17 @@ public CompileKotlinOptions classpath(Collection<String> paths) {
return this;
}

/**
* Evaluate the given string as a Kotlin script.
*
* @param expression the expression
* @return this operation instance
*/
public CompileKotlinOptions expression(String expression) {
expression_ = expression;
return this;
}

/**
* Indicates whether the {@link #jdkRelease(String) jdkRelease} was set.
*
Expand Down Expand Up @@ -346,6 +398,28 @@ public CompileKotlinOptions jdkRelease(int version) {
return this;
}

/**
* Pass an option directly to JVM
*
* @param jvmOptions one or more JVM option
* @return this operation instance
*/
public CompileKotlinOptions jvmOptions(String... jvmOptions) {
Collections.addAll(jvmOptions_, jvmOptions);
return this;
}

/**
* Pass an option directly to JVM
*
* @param jvmOptions the list JVM options
* @return this operation instance
*/
public CompileKotlinOptions jvmOptions(Collection<String> jvmOptions) {
jvmOptions_.addAll(jvmOptions);
return this;
}

/**
* Specify the target version of the generated JVM bytecode.
* <p>
Expand Down
74 changes: 65 additions & 9 deletions src/test/java/rife/bld/extension/CompileKotlinOptionsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
import org.junit.jupiter.api.Test;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.IntStream;
Expand All @@ -30,8 +33,10 @@ class CompileKotlinOptionsTest {
@Test
void argsCollectionTest() {
var args = new CompileKotlinOptions()
.advancedOptions(List.of("Xoption1", "Xoption2"))
.argFile(List.of("arg1.txt", "arg2.txt"))
.classpath(List.of("path1", "path2"))
.jvmOptions(List.of("option1", "option2"))
.noStdLib(false)
.optIn(List.of("opt1", "opt2"))
.options(List.of("-foo", "-bar"))
Expand All @@ -40,19 +45,27 @@ void argsCollectionTest() {
var matches = List.of(
"@arg1.txt", "@arg2.txt",
"-classpath", "path1:path2",
"-Joption1", "-Joption2",
"-opt-in", "opt1",
"-opt-in", "opt2",
"-foo",
"-bar",
"-script-templates", "temp1,temp2");

assertThat(args).hasSize(matches.size());

IntStream.range(0, args.size()).forEach(i -> assertThat(args.get(i)).isEqualTo(matches.get(i)));

"-foo", "-bar",
"-script-templates",
"temp1,temp2",
"-XXoption1", "-XXoption2");

for (var arg : args) {
var found = false;
for (var match : matches) {
if (match.equals(arg)) {
found = true;
break;
}
}
assertThat(found).as(arg).isTrue();
}
}


@Test
void argsTest() {
var options = new CompileKotlinOptions()
Expand Down Expand Up @@ -93,7 +106,7 @@ void argsTest() {
"-module-name", "module",
"-no-jdk",
"-no-reflect",
"-no-warn",
"-nowarn",
"-opt-in", "opt1",
"-opt-in", "opt2",
"-foo",
Expand All @@ -114,4 +127,47 @@ void argsTest() {
IntStream.range(0, a.size()).forEach(i -> assertThat(a.get(i)).isEqualTo(matches.get(i)));
}
}

@Test
void checkAllParamsTest() throws IOException {
var args = Files.readAllLines(Paths.get("src", "test", "resources", "kotlinc-args.txt"));

assertThat(args).isNotEmpty();

var params = new CompileKotlinOptions()
.advancedOptions("Xoption")
.argFile("file")
.classpath("classpath")
.expression("expression")
.jvmOptions("option")
.includeRuntime(true)
.javaParameters(true)
.jdkHome("jdkhome")
.jvmTarget(12)
.kotlinHome("kotlin")
.moduleName("moduleName")
.noJdk(true)
.noReflect(true)
.noStdLib(true)
.noWarn(true)
.optIn("annotation")
.options("option")
.path("path")
.plugin("id", "option", "value")
.progressive(true)
.scriptTemplates("template")
.verbose(true)
.wError(true);

for (var p : args) {
var found = false;
for (var a : params.args()) {
if (a.startsWith(p)) {
found = true;
break;
}
}
assertThat(found).as(p + " not found.").isTrue();
}
}
}
20 changes: 10 additions & 10 deletions src/test/java/rife/bld/extension/dokka/DokkaOperationTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ class DokkaOperationTest {
@Test
@SuppressWarnings({"ExtractMethodRecommender", "PMD.AvoidDuplicateLiterals"})
void executeConstructProcessCommandListTest() throws IOException {
var params = Files.readAllLines(Paths.get("src", "test", "resources", "dokka-args.txt"));
var args = Files.readAllLines(Paths.get("src", "test", "resources", "dokka-args.txt"));

assertThat(params).isNotEmpty();
assertThat(args).isNotEmpty();

var examples = new File("examples");
var jsonConf = new File("config.json");
var args = new DokkaOperation()
var params = new DokkaOperation()
.delayTemplateSubstitution(true)
.failOnWarning(true)
.fromProject(new BaseProjectBlueprint(examples, "com.example", "Example"))
Expand Down Expand Up @@ -72,9 +72,9 @@ void executeConstructProcessCommandListTest() throws IOException {
.suppressInheritedMembers(true)
.executeConstructProcessCommandList();

for (var p : params) {
for (var p : args) {
var found = false;
for (var a : args) {
for (var a : params) {
if (a.startsWith(p)) {
found = true;
break;
Expand Down Expand Up @@ -109,14 +109,14 @@ void executeConstructProcessCommandListTest() throws IOException {
"-suppressInheritedMembers",
jsonConf.getAbsolutePath());

assertThat(args).hasSize(matches.size());
assertThat(params).hasSize(matches.size());

IntStream.range(0, args.size()).forEach(i -> {
if (args.get(i).contains(".jar;")) {
var jars = args.get(i).split(";");
IntStream.range(0, params.size()).forEach(i -> {
if (params.get(i).contains(".jar;")) {
var jars = params.get(i).split(";");
Arrays.stream(jars).forEach(jar -> assertThat(matches.get(i)).as(matches.get(i)).contains(jar));
} else {
assertThat(args.get(i)).as(args.get(i)).isEqualTo(matches.get(i));
assertThat(params.get(i)).as(params.get(i)).isEqualTo(matches.get(i));
}
});
}
Expand Down
Loading

0 comments on commit 1623b90

Please sign in to comment.