New test for the correct naming of concrete type version classes #1791
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright (c) 2010, 2025 BSI Business Systems Integration AG | ||
| * | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.scout.rt.dataobject.testing; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.regex.Matcher; | ||
|
|
||
| import org.eclipse.scout.rt.dataobject.AbstractTypeVersion; | ||
| import org.eclipse.scout.rt.dataobject.ITypeVersion; | ||
| import org.eclipse.scout.rt.platform.BEANS; | ||
| import org.eclipse.scout.rt.platform.util.CollectionUtility; | ||
| import org.eclipse.scout.rt.platform.util.StringUtility; | ||
| import org.eclipse.scout.rt.testing.platform.runner.PlatformTestRunner; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
|
|
||
| @RunWith(PlatformTestRunner.class) | ||
| public abstract class AbstractTypeVersionClassNamingTest { | ||
|
|
||
| @Test | ||
| public final void testTypeVersions() { | ||
| List<String> malformedTypeVersionClassNames = collectMalformedTypeVersionClassNames(); | ||
| if (!malformedTypeVersionClassNames.isEmpty()) { | ||
| Assert.fail("Malformed type version class names found.\nType version class names must follow the following pattern: " | ||
| + "<Namespace>_<version1>[_<version2>[_<versionN>]][__<comment>] where <Namespace> must be called after the respective scout namespace with all " | ||
| + "letters in lower case except for the first letter, which must be capitalized.\n- " + String.join("\n- ", malformedTypeVersionClassNames)); | ||
| } | ||
| } | ||
|
|
||
| protected abstract String getPackageNamePrefix(); | ||
|
|
||
| protected Set<Class<ITypeVersion>> getExclusionList() { | ||
| return CollectionUtility.emptyHashSet(); | ||
| } | ||
|
|
||
| protected List<String> collectMalformedTypeVersionClassNames() { | ||
| String packagePrefix = getPackageNamePrefix(); | ||
|
|
||
| Set<Class<ITypeVersion>> excludedTypeVersions = getExclusionList(); | ||
|
|
||
| return BEANS.all(ITypeVersion.class).stream() | ||
| .map(Object::getClass) | ||
| .filter(typeVersionClass -> !excludedTypeVersions.contains(typeVersionClass)) | ||
| .filter(typeVersionClass -> typeVersionClass.getPackageName().startsWith(packagePrefix)) | ||
| .map(Class::getSimpleName) | ||
| .filter(this::isMalformedTypeVersionClassName) | ||
| .toList(); | ||
| } | ||
|
|
||
| protected boolean isMalformedTypeVersionClassName(String className) { | ||
| Matcher matcher = AbstractTypeVersion.CLASS_NAME_PATTERN.matcher(className); | ||
| if (!matcher.matches()) { | ||
| return false; | ||
| } | ||
|
|
||
| String actualNamespaceIdString = matcher.group(1); | ||
| String expectedNamespaceIdString = StringUtility.uppercaseFirst(actualNamespaceIdString.toLowerCase()); | ||
|
|
||
| return !actualNamespaceIdString.equals(expectedNamespaceIdString); | ||
|
Member
There was a problem hiding this comment. What will we do with all the Fixture Type Versions that we have in Scout? For example
Contributor
Author
There was a problem hiding this comment. Thats a good point which also raises the question why they do have a "wrong" name in the first place. What are your thoughts on that?
Member
There was a problem hiding this comment. Not sure why we use these names for the Fixture Type Versions that don't match the naming pattern. Maybe @paolobazzi or @LukasHuser know more about this topic?
Member
There was a problem hiding this comment. I think those names are a (legacy) shortcut choosen to simplify tests (and using differtent namespaces we did not have to deal with duplicated type names). |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright (c) 2010, 2025 BSI Business Systems Integration AG | ||
| * | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.scout.rt.dataobject.testing; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.core.Is.is; | ||
|
|
||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.eclipse.scout.rt.platform.BEANS; | ||
| import org.junit.Test; | ||
|
|
||
| public abstract class AbstractTypeVersionClassNamingTestSupportTest { | ||
|
|
||
| @Test | ||
| public void testFilePattern() { | ||
| Pattern filePattern = BEANS.get(TypeVersionClassNamingTestSupport.class).getFilePattern(); | ||
|
|
||
| assertThat(filePattern.matcher("class MyVersion extends AbstractTypeVersion {}").find(), is(true)); | ||
| assertThat(filePattern.matcher("public class MyVersion extends AbstractTypeVersion {}").find(), is(true)); | ||
| assertThat(filePattern.matcher("final class MyVersion extends AbstractTypeVersion {}").find(), is(true)); | ||
| assertThat(filePattern.matcher("public final class MyVersion extends AbstractTypeVersion {}").find(), is(true)); | ||
| assertThat(filePattern.matcher("class MyVersion extends AbstractTypeVersionTest {}").find(), is(false)); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /* | ||
| * Copyright (c) 2010, 2025 BSI Business Systems Integration AG | ||
| * | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.scout.rt.dataobject.testing; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| public class TypeVersionClassNamingTestSupport extends AbstractDataObjectTestSupport { | ||
|
|
||
| @Override | ||
| protected Pattern createFilePattern() { | ||
| return Pattern.compile("class \\w+ extends AbstractTypeVersion\\b"); | ||
| } | ||
|
|
||
| @Override | ||
| protected Pattern createTestFilePattern() { | ||
| return Pattern.compile("\\bextends AbstractTypeVersionClassNamingTest\\b"); | ||
| } | ||
|
|
||
| @Override | ||
| protected Pattern createPackageNamePrefixPattern() { | ||
| return Pattern.compile("String getPackageNamePrefix\\(\\)\\s*\\{\\s*return \\s*\"(.+?)\";\\s*}"); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean acceptFile(Path path, String content) { | ||
| return !path.toString().contains(Path.of("src/test").toString()) && !path.getFileName().toString().endsWith("Test.java") && getFilePattern().matcher(content).find(); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean acceptTestFile(Path path, String content) { | ||
| return path.getFileName().toString().endsWith("TypeVersionClassNamingTest.java") && getTestFilePattern().matcher(content).find(); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getErrorTitle() { | ||
| return "No TypeVersionClassNamingTest found for the following files:"; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /* | ||
| * Copyright (c) 2010, 2025 BSI Business Systems Integration AG | ||
| * | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.scout.rt.dataobject; | ||
|
|
||
| import org.eclipse.scout.rt.dataobject.testing.AbstractTypeVersionClassNamingTest; | ||
|
|
||
| public class ScoutDataObjectTypeVersionClassNamingTest extends AbstractTypeVersionClassNamingTest { | ||
| @Override | ||
| protected String getPackageNamePrefix() { | ||
| return "org.eclipse.scout.rt.dataobject"; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.