Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@testforstephen
testforstephen committed Jun 7, 2024
1 parent 4812811 commit 5f60fc3
Show file tree
Hide file tree
Showing 15 changed files with 510 additions and 276 deletions.
2 changes: 1 addition & 1 deletion ...eclipse.jdt.apt.core/src/org/eclipse/jdt/apt/core/internal/AptCompilationParticipant.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ public String[] getGeneratedSourcePaths(IJavaProject project, boolean isTest) {
}

IFolder folder = generatedSourceFolderManager.getFolder();
return folder == null ? null : new String[] { folder.getLocation().toOSString() };
return folder == null || folder.getLocation() == null ? null : new String[] { folder.getLocation().toOSString() };
}

@Override
Expand Down
12 changes: 12 additions & 0 deletions org.eclipse.jdt.core.tests.builder/resources/autoValueSnippet/.classpath
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11"/>
<classpathentry kind="src" path="src"/>
<classpathentry kind="lib" path="libs/auto-value-annotations-1.6.5.jar"/>
<classpathentry kind="src" path=".apt_generated">
<attributes>
<attribute name="optional" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="bin"/>
</classpath>
4 changes: 4 additions & 0 deletions org.eclipse.jdt.core.tests.builder/resources/autoValueSnippet/.factorypath
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<factorypath>
<factorypathentry kind="WKSPJAR" id="/autoValueSnippet/libs/auto-value-1.6.5.jar" enabled="true" runInBatchMode="false"/>
<factorypathentry kind="WKSPJAR" id="/autoValueSnippet/libs/auto-value-annotations-1.6.5.jar" enabled="true" runInBatchMode="false"/>
</factorypath>
19 changes: 19 additions & 0 deletions org.eclipse.jdt.core.tests.builder/resources/autoValueSnippet/.project
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>autoValueSnippet</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.jdt.core.javanature</nature>
</natures>
<filteredResources>
</filteredResources>
</projectDescription>
5 changes: 5 additions & 0 deletions ...dt.core.tests.builder/resources/autoValueSnippet/.settings/org.eclipse.jdt.apt.core.prefs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
eclipse.preferences.version=1
org.eclipse.jdt.apt.aptEnabled=true
org.eclipse.jdt.apt.genSrcDir=.apt_generated
org.eclipse.jdt.apt.genTestSrcDir=.apt_generated_tests
org.eclipse.jdt.apt.reconcileEnabled=true
16 changes: 16 additions & 0 deletions ...se.jdt.core.tests.builder/resources/autoValueSnippet/.settings/org.eclipse.jdt.core.prefs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate
org.eclipse.jdt.core.compiler.codegen.targetPlatform=11
org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
org.eclipse.jdt.core.compiler.compliance=11
org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning
org.eclipse.jdt.core.compiler.processAnnotations=enabled
org.eclipse.jdt.core.compiler.release=enabled
org.eclipse.jdt.core.compiler.source=11
Binary file added org.eclipse.jdt.core.tests.builder/resources/autoValueSnippet/libs/auto-value-1.6.5.jar
View file
Binary file not shown.
Binary file added ...e.jdt.core.tests.builder/resources/autoValueSnippet/libs/auto-value-annotations-1.6.5.jar
View file
Binary file not shown.
23 changes: 23 additions & 0 deletions org.eclipse.jdt.core.tests.builder/resources/autoValueSnippet/src/Outer.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import com.google.auto.value.AutoValue;

@AutoValue
public abstract class Outer {

public static Outer create(Inner value) {
return new AutoValue_Outer(value);
}

public abstract Inner inner();

@AutoValue
public abstract static class Inner {

public static Inner create(String value) {
return new AutoValue_Outer_Inner(value);
}

public abstract String value();

}

}
226 changes: 201 additions & 25 deletions ...clipse.jdt.core.tests.builder/src/org/eclipse/jdt/core/tests/builder/BasicBuildTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,51 @@
*******************************************************************************/
package org.eclipse.jdt.core.tests.builder;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.StandardCopyOption;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;

import junit.framework.*;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.jdt.core.compiler.*;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.tests.util.Util;
import org.eclipse.jdt.internal.compiler.CompilationResult;
import org.eclipse.jdt.internal.compiler.Compiler;
import org.eclipse.jdt.internal.compiler.CompilerConfiguration;
import org.eclipse.jdt.internal.compiler.ICompilerFactory;
import org.eclipse.jdt.internal.compiler.ICompilerRequestor;
import org.eclipse.jdt.internal.compiler.IErrorHandlingPolicy;
import org.eclipse.jdt.internal.compiler.IProblemFactory;
import org.eclipse.jdt.internal.compiler.env.ICompilationUnit;
import org.eclipse.jdt.internal.compiler.env.INameEnvironment;
import org.eclipse.jdt.internal.compiler.impl.CompilerOptions;
import org.eclipse.jdt.internal.compiler.problem.DefaultProblem;
import org.eclipse.jdt.internal.compiler.problem.ProblemSeverities;
import org.eclipse.jdt.internal.core.JavaModelManager;
Expand Down Expand Up @@ -697,11 +723,10 @@ public void testBug549942() throws JavaModelException {
}
}

public void testCustomCompiler() throws JavaModelException {
final String CUSTOM_COMPILER_KEY = AbstractImageBuilder.class.getSimpleName() + ".compiler";
final String CUSTOM_COMPILER_VALUE = MockCompiler.class.getName();
public void testCustomCompilerFactory() throws JavaModelException {
final String CUSTOM_COMPILER_VALUE = MockCompilerFactory.class.getName();
try {
System.setProperty(CUSTOM_COMPILER_KEY, CUSTOM_COMPILER_VALUE);
System.setProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY, CUSTOM_COMPILER_VALUE);
IPath projectPath = env.addProject("Project"); //$NON-NLS-1$
env.addExternalJars(projectPath, Util.getJavaClassLibs());

Expand All @@ -712,12 +737,14 @@ public void testCustomCompiler() throws JavaModelException {
env.setOutputFolder(projectPath, "bin"); //$NON-NLS-1$

IPath path = env.addClass(root, "p1", "Hello", //$NON-NLS-1$ //$NON-NLS-2$
"package p1;\n"+ //$NON-NLS-1$
"public class Hello {\n"+ //$NON-NLS-1$
" public static void main(String args[]) {\n"+ //$NON-NLS-1$
" System.out.println(\"Hello world\");\n"+ //$NON-NLS-1$
" }\n"+ //$NON-NLS-1$
"}\n" //$NON-NLS-1$
"""
package p1;
public class Hello {
public static void main(String args[]) {
System.out.println(\"Hello world\");
}
}
"""
);

fullBuild(projectPath);
Expand All @@ -727,15 +754,139 @@ public void testCustomCompiler() throws JavaModelException {
"Problem : Compilation error from MockCompiler [ resource : </Project/src/p1/Hello.java> range : <0,1> category : <60> severity : <2>]"
);
} finally {
System.clearProperty(CUSTOM_COMPILER_KEY);
System.clearProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY);
}
}

public void testFallbackForProblematicCompiler() throws JavaModelException {
final String CUSTOM_COMPILER_KEY = AbstractImageBuilder.class.getSimpleName() + ".compiler";
final String CUSTOM_COMPILER_VALUE = "x.y.NotFoundCompiler";
public void testCustomerCompilerFactoryWithAP() throws Exception {
final String CUSTOM_COMPILER_VALUE = MockCompilerFactory.class.getName();
List<CompilerConfiguration> configs = new ArrayList<>();
Consumer<Compiler> listener = (compiler) -> {
if (compiler instanceof MockCompiler mockCompiler) {
configs.add(mockCompiler.compilerConfig);
}
};
try {
MockCompilerFactory.addListener(listener);
System.setProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY, CUSTOM_COMPILER_VALUE);
File projectRoot = copyFiles("autoValueSnippet", true);
IPath dotProjectPath = new org.eclipse.core.runtime.Path(new File(projectRoot, IProjectDescription.DESCRIPTION_FILE_NAME).getAbsolutePath());
IWorkspace workspace = ResourcesPlugin.getWorkspace();
IProjectDescription descriptor = workspace.loadProjectDescription(dotProjectPath);
String projectName = descriptor.getName();
IProject project = workspace.getRoot().getProject(projectName);
project.create(descriptor, new NullProgressMonitor());
project.open(IResource.NONE, new NullProgressMonitor());

// full build
project.build(IncrementalProjectBuilder.FULL_BUILD, null);

// It creates compiler 4 times (MAIN full build, TEST full build, MAIN incremental build, TEST incremental build)
assertEquals(4, configs.size());
CompilerConfiguration config = configs.get(0);
List<String> processorPaths = config.annotationProcessorPaths();
assertEquals(2, processorPaths.size());
assertTrue(processorPaths.get(0).endsWith("auto-value-1.6.5.jar"));
assertTrue(processorPaths.get(1).endsWith("auto-value-annotations-1.6.5.jar"));

List<String> generatedSourcePaths = config.generatedSourcePaths();
assertEquals(1, generatedSourcePaths.size());
assertTrue(generatedSourcePaths.get(0).endsWith(".apt_generated"));

List<String> sourcePaths = config.sourcepaths();
assertEquals(2, sourcePaths.size());
assertTrue(sourcePaths.get(0).endsWith("src"));
assertTrue(sourcePaths.get(1).endsWith(".apt_generated"));

List<String> classPaths = config.classpaths();
assertEquals(2, classPaths.size());
assertTrue(classPaths.get(0).endsWith("bin"));
assertTrue(classPaths.get(1).endsWith("auto-value-annotations-1.6.5.jar"));

List<String> moduleSourcePaths = config.moduleSourcepaths();
assertEquals(0, moduleSourcePaths.size());

List<String> modulePaths = config.modulepaths();
assertEquals(0, modulePaths.size());

Map<File, File> sourceOutputMapping = config.sourceOutputMapping();
assertEquals(2, sourceOutputMapping.size());

IFile aptGeneratedFile = project.getFile(".apt_generated/AutoValue_Outer.java");
assertFalse("The default APT generation should be disabled for custom compiler", aptGeneratedFile.exists());
} finally {
MockCompilerFactory.removeListener(listener);
System.clearProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY);
}
}

private File copyFiles(String path, boolean reimportIfExists) throws IOException {
File from = new File(getSourceProjectDirectory(), path);
File to = new File(getWorkingProjectDirectory(), path);
if (to.exists()) {
if (!reimportIfExists) {
return to;
}
if (to.isFile()) {
Files.delete(to.toPath());
} else {
deleteDirectory(to.toPath());
}
}

if (from.isDirectory()) {
copyDirectory(from.toPath(), to.toPath());
} else {
Files.copy(from.toPath(), to.toPath(), StandardCopyOption.REPLACE_EXISTING);
}

return to;
}

private File getSourceProjectDirectory() {
return new File("resources");
}

private File getWorkingProjectDirectory() throws IOException {
File dir = new File("target", "workingProjects");
if (!dir.exists()) {
dir.mkdirs();
}
return dir;
}

private static void deleteDirectory(Path path) throws IOException {
Files.walkFileTree(path, new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
Files.delete(file);
return FileVisitResult.CONTINUE;
}

@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
Files.delete(dir);
return FileVisitResult.CONTINUE;
}
});
}

private static void copyDirectory(Path sourceDirectory, Path targetDirectory) throws IOException {
Files.walk(sourceDirectory)
.forEach(sourcePath -> {
Path targetPath = targetDirectory.resolve(sourceDirectory.relativize(sourcePath));
try {
Files.copy(sourcePath, targetPath, StandardCopyOption.REPLACE_EXISTING);
} catch (IOException e) {
// ignore
}
});
}

public void testFallbackForProblematicCompilerFactory() throws JavaModelException {
final String CUSTOM_COMPILER_VALUE = "x.y.NotFoundCompilerFactory";
try {
System.setProperty(CUSTOM_COMPILER_KEY, CUSTOM_COMPILER_VALUE);
System.setProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY, CUSTOM_COMPILER_VALUE);
IPath projectPath = env.addProject("Project"); //$NON-NLS-1$
env.addExternalJars(projectPath, Util.getJavaClassLibs());

Expand All @@ -746,12 +897,14 @@ public void testFallbackForProblematicCompiler() throws JavaModelException {
env.setOutputFolder(projectPath, "bin"); //$NON-NLS-1$

IPath path = env.addClass(root, "p1", "Hello", //$NON-NLS-1$ //$NON-NLS-2$
"package p1;\n"+ //$NON-NLS-1$
"public class Hello {\n"+ //$NON-NLS-1$
" public static void main(String args[]) {\n"+ //$NON-NLS-1$
" int unUsedVarable;\n"+ //$NON-NLS-1$
" }\n"+ //$NON-NLS-1$
"}\n" //$NON-NLS-1$
"""
package p1;
public class Hello {
public static void main(String args[]) {
int unUsedVarable;
}
}
"""
);

fullBuild(projectPath);
Expand All @@ -762,16 +915,39 @@ public void testFallbackForProblematicCompiler() throws JavaModelException {
"Problem : The value of the local variable unUsedVarable is not used [ resource : </Project/src/p1/Hello.java> range : <87,100> category : <120> severity : <1>]"
);
} finally {
System.clearProperty(CUSTOM_COMPILER_KEY);
System.clearProperty(AbstractImageBuilder.COMPILER_FACTORY_KEY);
}
}

public static class MockCompilerFactory implements ICompilerFactory {
static Set<Consumer<Compiler>> listeners = new HashSet<>();

@Override
public Compiler newCompiler(INameEnvironment environment, IErrorHandlingPolicy policy,
CompilerConfiguration compilerConfig, ICompilerRequestor requestor, IProblemFactory problemFactory) {
Compiler compiler = new MockCompiler(environment, policy, compilerConfig, requestor, problemFactory);
for (Consumer<Compiler> listener : listeners) {
listener.accept(compiler);
}

return compiler;
}

static void addListener(Consumer<Compiler> listener) {
listeners.add(listener);
}

static void removeListener(Consumer<Compiler> listener) {
listeners.remove(listener);
}
}

public static class MockCompiler extends org.eclipse.jdt.internal.compiler.Compiler {
private CompilerConfiguration compilerConfig;
static class MockCompiler extends org.eclipse.jdt.internal.compiler.Compiler {
CompilerConfiguration compilerConfig;

public MockCompiler(INameEnvironment environment, IErrorHandlingPolicy policy, CompilerConfiguration compilerConfig,
ICompilerRequestor requestor, IProblemFactory problemFactory) {
super(environment, policy, compilerConfig.getOptions(), requestor, problemFactory);
super(environment, policy, new CompilerOptions(compilerConfig.compilerOptions()), requestor, problemFactory);
this.compilerConfig = compilerConfig;
}

Expand Down
Loading

0 comments on commit 5f60fc3

Please sign in to comment.