Skip to content

Commit

Permalink
Merge pull request #574 from himamis/arbitrary-arg-length
Browse files Browse the repository at this point in the history 
Arbitrary arg length
  • Loading branch information
@brunobowden
brunobowden committed Jan 6, 2016
2 parents 38b61c2 + e00f068 commit 4646490
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 17 deletions.
32 changes: 27 additions & 5 deletions src/main/groovy/com/github/j2objccontrib/j2objcgradle/tasks/TranslateTask.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ class TranslateTask extends DefaultTask {
project.files(getTranslateSourcepaths()),
project.files(getGeneratedSourceDirs())
])
doTranslate(sourcepathDirs, srcGenMainDir, translateArgs, mainSrcFilesChanged)
doTranslate(sourcepathDirs, srcGenMainDir, translateArgs, mainSrcFilesChanged, "mainSrcFilesArgFile")

// Translate test code. Tests are never built with --build-closure; otherwise
// we will get duplicate symbol errors.
Expand All @@ -269,7 +269,7 @@ class TranslateTask extends DefaultTask {
project.files(getTranslateSourcepaths()),
project.files(getGeneratedSourceDirs())
])
doTranslate(sourcepathDirs, srcGenTestDir, testTranslateArgs, testSrcFilesChanged)
doTranslate(sourcepathDirs, srcGenTestDir, testTranslateArgs, testSrcFilesChanged, "testSrcFilesArgFile")
}

int deleteRemovedFiles(List<String> removedFileNames, File dir) {
Expand All @@ -292,7 +292,7 @@ class TranslateTask extends DefaultTask {
}

void doTranslate(UnionFileCollection sourcepathDirs, File srcDir, List<String> translateArgs,
FileCollection srcFilesToTranslate) {
FileCollection srcFilesToTranslate, String srcFilesArgFilename) {
int num = srcFilesToTranslate.getFiles().size()
logger.info("Translating $num files with j2objc...")
if (srcFilesToTranslate.getFiles().size() == 0) {
Expand All @@ -318,6 +318,27 @@ class TranslateTask extends DefaultTask {
String classpathArg = Utils.joinedPathArg(classpathFiles) +
Utils.pathSeparator() + "${project.buildDir}/classes"

// Source files arguments
List<String> srcFilesArgs = []
int srcFilesArgsCharCount = 0
for (File file in srcFilesToTranslate) {
String filePath = file.getPath()
srcFilesArgs.add(filePath)
srcFilesArgsCharCount += filePath.length() + 1
}

// Handle command line that's too long
// Allow up to 2,000 characters for command line excluding src files
// http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javac.html#commandlineargfile
if (srcFilesArgsCharCount + 2000 > Utils.maxArgs()) {
File srcFilesArgFile = new File(getTemporaryDir(), srcFilesArgFilename);
FileWriter writer = new FileWriter(srcFilesArgFile);
writer.append(srcFilesArgs.join('\n'));
writer.close()
// Replace src file arguments by referencing file
srcFilesArgs = ["@${srcFilesArgFile.path}".toString()]
}

ByteArrayOutputStream stdout = new ByteArrayOutputStream()
ByteArrayOutputStream stderr = new ByteArrayOutputStream()

Expand All @@ -338,8 +359,9 @@ class TranslateTask extends DefaultTask {
}

// File Inputs
srcFilesToTranslate.each { File file ->
args file.path
srcFilesArgs.each { String arg ->
// Can be list of src files or a single @/../srcFilesArgFile reference
args arg
}

setStandardOutput stdout
Expand Down
21 changes: 21 additions & 0 deletions src/main/groovy/com/github/j2objccontrib/j2objcgradle/tasks/Utils.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -695,4 +695,25 @@ class Utils {
}
return files
}


// Max number of characters for OS command line
static int maxArgs() {
if (isMacOSX()) {
// http://www.in-ulm.de/~mascheck/various/argmax/
return 262144
}
if (isWindows()) {
// Assume Windows XP or later which has max of 8191
// https://support.microsoft.com/en-us/kb/830473
return 8191
}
if (isLinux()) {
// v2.6.23 (released 2007) or later limit is 1/4 of stack size,
// so Linux is presumed to have no limit
// http://www.in-ulm.de/~mascheck/various/argmax/
return Integer.MAX_VALUE
}
assert false
}
}
93 changes: 81 additions & 12 deletions src/test/groovy/com/github/j2objccontrib/j2objcgradle/tasks/TranslateTaskTest.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,9 @@ class TranslateTaskTest {
(proj, j2objcHome, j2objcConfig) = TestingUtils.setupProject(
new TestingUtils.ProjectConfig(applyJavaPlugin: true, createJ2objcConfig: true))

// The files in these folders are created by the 'genNonIncrementalInputs' method
proj.file('src/main/java/com/example').mkdirs()
proj.file('src/main/java/com/example/Main.java').write("// Fake")
proj.file('src/test/java/com/example').mkdirs()
proj.file('src/test/java/com/example/Verify.java').write("// Fake")
}

// TODO: add java source files to the test cases
Expand All @@ -61,7 +60,7 @@ class TranslateTaskTest {
'-d', '/PROJECT_DIR/build/j2objcSrcGenMain',
'-sourcepath', '/PROJECT_DIR/src/main/java:/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar:/J2OBJC_HOME/lib/j2objc_guava.jar:/J2OBJC_HOME/lib/j2objc_junit.jar:/J2OBJC_HOME/lib/jre_emul.jar:/J2OBJC_HOME/lib/javax.inject-1.jar:/J2OBJC_HOME/lib/jsr305-3.0.0.jar:/J2OBJC_HOME/lib/mockito-core-1.9.5.jar:/J2OBJC_HOME/lib/hamcrest-core-1.3.jar:/J2OBJC_HOME/lib/protobuf_runtime.jar:/PROJECT_DIR/build/classes',
'/PROJECT_DIR/src/main/java/com/example/Main.java'
'/PROJECT_DIR/src/main/java/com/example/Main1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand All @@ -75,7 +74,7 @@ class TranslateTaskTest {
'-d', '/PROJECT_DIR/build/j2objcSrcGenTest',
'-sourcepath', '/PROJECT_DIR/src/main/java:/PROJECT_DIR/src/test/java:/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar:/J2OBJC_HOME/lib/j2objc_guava.jar:/J2OBJC_HOME/lib/j2objc_junit.jar:/J2OBJC_HOME/lib/jre_emul.jar:/J2OBJC_HOME/lib/javax.inject-1.jar:/J2OBJC_HOME/lib/jsr305-3.0.0.jar:/J2OBJC_HOME/lib/mockito-core-1.9.5.jar:/J2OBJC_HOME/lib/hamcrest-core-1.3.jar:/J2OBJC_HOME/lib/protobuf_runtime.jar:/PROJECT_DIR/build/classes',
'/PROJECT_DIR/src/test/java/com/example/Verify.java'
'/PROJECT_DIR/src/test/java/com/example/Verify1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand Down Expand Up @@ -104,7 +103,7 @@ class TranslateTaskTest {
'-d', '/PROJECT_DIR/build/j2objcSrcGenMain',
'-sourcepath', '/PROJECT_DIR/src/main/java;/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar;/J2OBJC_HOME/lib/j2objc_guava.jar;/J2OBJC_HOME/lib/j2objc_junit.jar;/J2OBJC_HOME/lib/jre_emul.jar;/J2OBJC_HOME/lib/javax.inject-1.jar;/J2OBJC_HOME/lib/jsr305-3.0.0.jar;/J2OBJC_HOME/lib/mockito-core-1.9.5.jar;/J2OBJC_HOME/lib/hamcrest-core-1.3.jar;/J2OBJC_HOME/lib/protobuf_runtime.jar;/PROJECT_DIR/build/classes',
'/PROJECT_DIR/src/main/java/com/example/Main.java'
'/PROJECT_DIR/src/main/java/com/example/Main1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand All @@ -118,7 +117,7 @@ class TranslateTaskTest {
'-d', '/PROJECT_DIR/build/j2objcSrcGenTest',
'-sourcepath', '/PROJECT_DIR/src/main/java;/PROJECT_DIR/src/test/java;/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar;/J2OBJC_HOME/lib/j2objc_guava.jar;/J2OBJC_HOME/lib/j2objc_junit.jar;/J2OBJC_HOME/lib/jre_emul.jar;/J2OBJC_HOME/lib/javax.inject-1.jar;/J2OBJC_HOME/lib/jsr305-3.0.0.jar;/J2OBJC_HOME/lib/mockito-core-1.9.5.jar;/J2OBJC_HOME/lib/hamcrest-core-1.3.jar;/J2OBJC_HOME/lib/protobuf_runtime.jar;/PROJECT_DIR/build/classes',
'/PROJECT_DIR/src/test/java/com/example/Verify.java'
'/PROJECT_DIR/src/test/java/com/example/Verify1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand Down Expand Up @@ -160,7 +159,7 @@ class TranslateTaskTest {
'-sourcepath', "/PROJECT_DIR/src/main/java:/PROJECT_DIR/REL-SOURCEPATH:$absSourcePath:/PROJECT_DIR/build/classes/main:/PROJECT_DIR/REL-GENPATH:$absGenPath",
'-classpath', "/PROJECT_DIR/REL-CLASSPATH:$absClassPath:/J2OBJC_HOME/lib/J2OBJC-LIB1:/J2OBJC_HOME/lib/J2OBJC-LIB2:/PROJECT_DIR/build/classes",
'-ARG1', '-ARG2',
'/PROJECT_DIR/src/main/java/com/example/Main.java'
'/PROJECT_DIR/src/main/java/com/example/Main1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand All @@ -174,7 +173,7 @@ class TranslateTaskTest {
'-sourcepath', "/PROJECT_DIR/src/main/java:/PROJECT_DIR/src/test/java:/PROJECT_DIR/REL-SOURCEPATH:$absSourcePath:/PROJECT_DIR/build/classes/main:/PROJECT_DIR/REL-GENPATH:$absGenPath",
'-classpath', "/PROJECT_DIR/REL-CLASSPATH:$absClassPath:/J2OBJC_HOME/lib/J2OBJC-LIB1:/J2OBJC_HOME/lib/J2OBJC-LIB2:/PROJECT_DIR/build/classes",
'-ARG1', '-ARG2',
'/PROJECT_DIR/src/test/java/com/example/Verify.java'
'/PROJECT_DIR/src/test/java/com/example/Verify1.java'
],
// expectedWindowsExecutableAndArgs
[
Expand All @@ -189,18 +188,88 @@ class TranslateTaskTest {
mockProjectExec.verify()
}

@Test
void translate_MaxArgsExceeded() {
// Artificially enforce max arg limit
// Use Windows here, because the test takes <1 second, compared to ~8 seconds on OS X
Utils.setFakeOSWindows()
// Translate large number of files to exceed max args
// srcFilesArgsCharCount = 40 (min chars for file path assumption) * 220
// = 8,800 (this is greater than 8,191, which is max args on Windows XP and above)
int fileCount = 220

TranslateTask j2objcTranslate = (TranslateTask) proj.tasks.create(
name: 'j2objcTranslate', type: TranslateTask) {
srcGenMainDir = proj.file(proj.file('build/j2objcSrcGenMain').absolutePath)
srcGenTestDir = proj.file(proj.file('build/j2objcSrcGenTest').absolutePath)
}

MockProjectExec mockProjectExec = new MockProjectExec(proj, j2objcHome)
mockProjectExec.demandExecAndReturn([
'/J2OBJC_HOME/j2objc',
'-d', '/PROJECT_DIR/build/j2objcSrcGenMain',
'-sourcepath', '/PROJECT_DIR/src/main/java:/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar:/J2OBJC_HOME/lib/j2objc_guava.jar:/J2OBJC_HOME/lib/j2objc_junit.jar:/J2OBJC_HOME/lib/jre_emul.jar:/J2OBJC_HOME/lib/javax.inject-1.jar:/J2OBJC_HOME/lib/jsr305-3.0.0.jar:/J2OBJC_HOME/lib/mockito-core-1.9.5.jar:/J2OBJC_HOME/lib/hamcrest-core-1.3.jar:/J2OBJC_HOME/lib/protobuf_runtime.jar:/PROJECT_DIR/build/classes',
'@/PROJECT_DIR/build/tmp/j2objcTranslate/mainSrcFilesArgFile'
],
// expectedWindowsExecutableAndArgs
[
'java',
'-jar',
'/J2OBJC_HOME/lib/j2objc.jar'
])

mockProjectExec.demandExecAndReturn([
'/J2OBJC_HOME/j2objc',
'-d', '/PROJECT_DIR/build/j2objcSrcGenTest',
'-sourcepath', '/PROJECT_DIR/src/main/java:/PROJECT_DIR/src/test/java:/PROJECT_DIR/build/classes/main',
'-classpath', '/J2OBJC_HOME/lib/j2objc_annotations.jar:/J2OBJC_HOME/lib/j2objc_guava.jar:/J2OBJC_HOME/lib/j2objc_junit.jar:/J2OBJC_HOME/lib/jre_emul.jar:/J2OBJC_HOME/lib/javax.inject-1.jar:/J2OBJC_HOME/lib/jsr305-3.0.0.jar:/J2OBJC_HOME/lib/mockito-core-1.9.5.jar:/J2OBJC_HOME/lib/hamcrest-core-1.3.jar:/J2OBJC_HOME/lib/protobuf_runtime.jar:/PROJECT_DIR/build/classes',
'@/PROJECT_DIR/build/tmp/j2objcTranslate/testSrcFilesArgFile'
],
// expectedWindowsExecutableAndArgs
[
'java',
'-jar',
'/J2OBJC_HOME/lib/j2objc.jar'
])

j2objcTranslate.translate(genNonIncrementalInputs(proj, fileCount))

// Verify arg files
List<String> mainSrcFiles = new File(j2objcTranslate.getTemporaryDir(), "mainSrcFilesArgFile").readLines()
assert mainSrcFiles.size() == fileCount
assert mainSrcFiles[0] == proj.file('src/main/java/com/example/Main1.java').path
assert mainSrcFiles[1] == proj.file('src/main/java/com/example/Main2.java').path
assert mainSrcFiles[fileCount - 1] == proj.file("src/main/java/com/example/Main${fileCount}.java").path

List<String> testSrcFiles = new File(j2objcTranslate.getTemporaryDir(), "testSrcFilesArgFile").readLines()
assert testSrcFiles.size() == fileCount
assert testSrcFiles[0] == proj.file('src/test/java/com/example/Verify1.java').path
assert testSrcFiles[1] == proj.file('src/test/java/com/example/Verify2.java').path
assert testSrcFiles[fileCount - 1] == proj.file("src/test/java/com/example/Verify${fileCount}.java").path

mockProjectExec.verify()
}


// Utility Method
private static IncrementalTaskInputs genNonIncrementalInputs(Project proj) {
private static IncrementalTaskInputs genNonIncrementalInputs(Project proj, int fileCountMultiplier = 1) {
IncrementalTaskInputs incrementalTaskInputs = new IncrementalTaskInputs() {
@Override
boolean isIncremental() { return false }

@Override
void outOfDate(Action<? super InputFileDetails> outOfDateAction) {
proj.files('src/main/java/com/example/Main.java',
'src/test/java/com/example/Verify.java').each {
final File file ->
assert fileCountMultiplier >= 1
List<String> srcFiles = []
(1..fileCountMultiplier).each { int idx ->
srcFiles.add("src/main/java/com/example/Main${idx}.java")
srcFiles.add("src/test/java/com/example/Verify${idx}.java")
}
proj.files(srcFiles).each { final File file ->
// Create the files
// TODO: prefer not to create all these temporary files just to run the test
file.write("// Fake")
outOfDateAction.execute(new InputFileDetails() {
@Override
boolean isAdded() {
Expand Down
18 changes: 18 additions & 0 deletions src/test/groovy/com/github/j2objccontrib/j2objcgradle/tasks/UtilsTest.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,4 +842,22 @@ class UtilsTest {
assert !Utils.isAtLeastVersion("0.9.8.1.2", "0.9.8.2.1")
assert !Utils.isAtLeastVersion("0.7.9", "0.9.8.2.1")
}

@Test
void testMaxArgs_Linux() {
Utils.setFakeOSLinux()
assert Integer.MAX_VALUE == Utils.maxArgs()
}

@Test
void testMaxArgs_OSX() {
Utils.setFakeOSMacOSX()
assert 262144 == Utils.maxArgs()
}

@Test
void testMaxArgs_Windows() {
Utils.setFakeOSWindows()
assert 8191 == Utils.maxArgs()
}
}

0 comments on commit 4646490

Please sign in to comment.