Skip to content

Commit

Permalink
[#1575] EmptyStackException with javadoc on record method
Browse files Browse the repository at this point in the history 
* support `record` types
  • Loading branch information
@ruspl-afed
ruspl-afed committed Jan 31, 2025
1 parent 2413246 commit 0fd77f2
Show file tree
Hide file tree
Showing 28 changed files with 921 additions and 13 deletions.
271 changes: 271 additions & 0 deletions ...i.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/InvalidRecordTagTests.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
/*******************************************************************************
* Copyright (c) 2025 ArSysOp.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Alexander Fedorov (ArSysOp) - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.tags;

import org.eclipse.core.runtime.IPath;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.pde.api.tools.internal.builder.BuilderMessages;
import org.eclipse.pde.api.tools.internal.problems.ApiProblemFactory;
import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescriptor;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem;

import junit.framework.Test;

/**
* Tests that the builder finds and properly reports invalid tags on records
*
* @since 1.4
*/
public class InvalidRecordTagTests extends TagTest {

public InvalidRecordTagTests(String name) {
super(name);
}

/**
* @return the tests for this class
*/
public static Test suite() {
return buildTestSuite(InvalidRecordTagTests.class);
}

@Override
protected String getTestingProjectName() {
return "java17tags"; //$NON-NLS-1$
}

@Override
protected IPath getTestSourcePath() {
return super.getTestSourcePath().append("record"); //$NON-NLS-1$
}

@Override
protected int getDefaultProblemId() {
return ApiProblemFactory.createProblemId(IApiProblem.CATEGORY_USAGE, IElementDescriptor.TYPE, IApiProblem.UNSUPPORTED_TAG_USE, IApiProblem.NO_FLAGS);
}

@Override
protected String getTestCompliance() {
return JavaCore.VERSION_14;
}

public void testInvalidRecordTag1I() {
x1(true);
}

public void testInvalidRecordTag1F() {
x1(false);
}

/**
* Tests having an @noreference tag on a variety of inner / outer /
* top-level record in package a.b.c
*/
private void x1(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(3));
setExpectedMessageArgs(new String[][] {
{ "@noreference", BuilderMessages.TagValidator_record_not_visible }, //$NON-NLS-1$
{ "@noreference", BuilderMessages.TagValidator_record_not_visible }, //$NON-NLS-1$
{ "@noreference", BuilderMessages.TagValidator_record_not_visible }, //$NON-NLS-1$
});
deployTagTest("test1.java", inc, false); //$NON-NLS-1$
}

public void testInvalidRecordTag3I() {
x3(true);
}

public void testInvalidRecordTag3F() {
x3(false);
}

/**
* Tests having an @noextend tag on a variety of inner / outer / top-level
* records in package a.b.c
*/
private void x3(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(4));
setExpectedMessageArgs(new String[][] {
{ "@noextend", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noextend", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noextend", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noextend", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test3.java", inc, false); //$NON-NLS-1$
}

public void testInvalidRecordTag4I() {
x4(true);
}

public void testInvalidRecordTag4F() {
x4(false);
}

/**
* Tests having an @noextend tag on an record in the default package
*/
private void x4(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(1));
setExpectedMessageArgs(new String[][] { {
"@noextend", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test4.java", inc, true); //$NON-NLS-1$
}

public void testInvalidRecordTag5I() {
x5(true);
}

public void testInvalidRecordTag5F() {
x5(false);
}

/**
* Tests having an @nooverride tag on a variety of inner / outer / top-level
* records in package a.b.c
*/
private void x5(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(4));
setExpectedMessageArgs(new String[][] {
{ "@nooverride", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@nooverride", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@nooverride", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@nooverride", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test5.java", inc, false); //$NON-NLS-1$
}

public void testInvalidRecordTag6I() {
x6(true);
}

public void testInvalidRecordTag6F() {
x6(false);
}

/**
* Tests having an @nooverride tag on a record in the default package
*/
private void x6(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(1));
setExpectedMessageArgs(new String[][] { {
"@nooverride", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test6.java", inc, true); //$NON-NLS-1$
}

public void testInvalidRecordTag7I() {
x7(true);
}

public void testInvalidRecordTag7F() {
x7(false);
}

/**
* Tests having an @noinstantiate on a variety of inner / outer / top-level
* records in package a.b.c
*/
private void x7(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(4));
setExpectedMessageArgs(new String[][] {
{ "@noinstantiate", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noinstantiate", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noinstantiate", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noinstantiate", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test7.java", inc, false); //$NON-NLS-1$
}

public void testInvalidRecordTag8I() {
x8(true);
}

public void testInvalidRecordTag8F() {
x8(false);
}

/**
* Tests having an @noinstantiate on a record in the default package
*/
private void x8(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(1));
setExpectedMessageArgs(new String[][] { {
"@noinstantiate", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test8.java", inc, true); //$NON-NLS-1$
}

public void testInvalidRecordTag9I() {
x9(true);
}

public void testInvalidRecordTag9F() {
x9(false);
}

/**
* Tests having an @noimplement tag on a variety of inner / outer /
* top-level records in package a.b.c
*/
private void x9(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(4));
setExpectedMessageArgs(new String[][] {
{ "@noimplement", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noimplement", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noimplement", BuilderMessages.TagValidator_a_record }, //$NON-NLS-1$
{ "@noimplement", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test9.java", inc, false); //$NON-NLS-1$
}

public void testInvalidRecordTag10I() {
x10(true);
}

public void testInvalidRecordTag10F() {
x10(false);
}

/**
* Tests having an @noimplement tag on a record in the default package
*/
private void x10(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(1));
setExpectedMessageArgs(new String[][] { {
"@noimplement", BuilderMessages.TagValidator_a_record } //$NON-NLS-1$
});
deployTagTest("test10.java", inc, true); //$NON-NLS-1$
}

public void testInvalidRecordTag11I() {
x11(true);
}

public void testInvalidRecordTag11F() {
x11(false);
}

/**
* Tests all tags are invalid when parent record is package default
*/
private void x11(boolean inc) {
setExpectedProblemIds(getDefaultProblemSet(1));
setExpectedMessageArgs(new String[][] {
{ "@noreference", BuilderMessages.TagValidator_record_not_visible } //$NON-NLS-1$
});
deployTagTest("test11.java", inc, true); //$NON-NLS-1$
}
}
5 changes: 4 additions & 1 deletion ...eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/TagTest.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2008, 2024 IBM Corporation and others.
* Copyright (c) 2008, 2025 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand All @@ -10,6 +10,7 @@
*
* Contributors:
* IBM Corporation - initial API and implementation
* Alexander Fedorov (ArSysOp) - support records
*******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.tags;

Expand Down Expand Up @@ -70,6 +71,8 @@ private static Class<?>[] getAllTestClasses() {
classes.add(ValidMethodTagTests.class);
classes.add(ValidEnumTagTests.class);
classes.add(InvalidEnumTagTests.class);
classes.add(InvalidRecordTagTests.class);
classes.add(ValidRecordTagTests.class);
classes.add(ValidAnnotationTagTests.class);
classes.add(InvalidAnnotationTagTests.class);
classes.add(InvalidDuplicateTagsTests.class);
Expand Down
56 changes: 56 additions & 0 deletions ...api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/ValidRecordTagTests.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*******************************************************************************
* Copyright (c) 2025 ArSysOp and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.tags;

import org.eclipse.core.runtime.IPath;

import junit.framework.Test;

/**
* Tests that the builder accepts valid tags on records
*/
public class ValidRecordTagTests extends InvalidRecordTagTests {

public ValidRecordTagTests(String name) {
super(name);
}

/**
* @return the tests for this class
*/
public static Test suite() {
return buildTestSuite(ValidRecordTagTests.class);
}

@Override
protected IPath getTestSourcePath() {
return super.getTestSourcePath().append("valid"); //$NON-NLS-1$
}

public void testValidRecordTag1I() {
x1(true);
}

@Override
public void testInvalidRecordTag1F() {
x1(false);
}

/**
* Tests having an @noreference tag on a record in the default package
*/
private void x1(boolean inc) {
deployTagTest("test1.java", inc, true); //$NON-NLS-1$
}
}
7 changes: 7 additions & 0 deletions apitools/org.eclipse.pde.api.tools.tests/test-builder/tagprojects/java17tags/.classpath
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?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-17"/>
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="src" path="src"/>
<classpathentry kind="output" path="bin"/>
</classpath>
34 changes: 34 additions & 0 deletions apitools/org.eclipse.pde.api.tools.tests/test-builder/tagprojects/java17tags/.project
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>java17tags</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.ManifestBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.SchemaBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.api.tools.apiAnalysisBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.pde.PluginNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.pde.api.tools.apiAnalysisNature</nature>
</natures>
</projectDescription>
Loading

0 comments on commit 0fd77f2

Please sign in to comment.