Skip to content

fix: exclude certain file patterns from map_deploy_to_develop (Java) #1995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tdruez merged 4 commits into from
Dec 12, 2025
Merged

fix: exclude certain file patterns from map_deploy_to_develop (Java) #1995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ccc8e7
Update the "deployed_resource_path_exclusions" #1872
chinyeungli Nov 19, 2025
4ff1156
Added exclude patterns for D2D #1872
chinyeungli Dec 11, 2025
8031487
Added test #1872
chinyeungli Dec 11, 2025
a7a20f2
Corrected test data #1872
chinyeungli Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion scanpipe/pipes/d2d_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,22 +80,37 @@ class EcosystemConfig:
".odt",
".odp",
],
deployed_resource_path_exclusions=["*.properties", "*.html"],
),
"Java": EcosystemConfig(
ecosystem_option="Java",
matchable_package_extensions=[".jar", ".war"],
matchable_resource_extensions=[".class"],
deployed_resource_path_exclusions=["*META-INF/*", "*/module-info.class"],
deployed_resource_path_exclusions=[
"*META-INF/*",
"*/module-info.class",
"*/OSGI-INF/*.xml",
"*/OSGI-INF/*.json",
"*spring-configuration-metadata.json",
],
),
"Scala": EcosystemConfig(
ecosystem_option="Scala",
matchable_package_extensions=[".jar", ".war"],
matchable_resource_extensions=[".class"],
deployed_resource_path_exclusions=[
"*META-INF/*",
],
),
"Kotlin": EcosystemConfig(
ecosystem_option="Kotlin",
matchable_package_extensions=[".jar", ".war"],
matchable_resource_extensions=[".class"],
deployed_resource_path_exclusions=[
"*META-INF/*",
"*.knm",
"*kotlin-project-structure-metadata.json",
],
),
"JavaScript": EcosystemConfig(
ecosystem_option="JavaScript",
Expand Down
2 changes: 1 addition & 1 deletion scanpipe/tests/data/d2d/config/ecosystem_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"matchable_package_extensions": [".jar", ".war", ".gem", ".zip", ".tar.gz", ".tar.xz"],
"matchable_resource_extensions": [".map", ".js", ".mjs", ".ts", ".d.ts", ".jsx", ".tsx", ".css", ".scss", ".less", ".sass", ".soy",".class", ".rb"],
"doc_extensions": [".pdf", ".doc", ".docx", ".ppt", ".pptx", ".tex", ".odt", ".odp"],
"deployed_resource_path_exclusions": ["*META-INF/*", "*/module-info.class", "*checksums.yaml.gz*", "*metadata.gz*", "*data.tar.gz.sig"],
"deployed_resource_path_exclusions": ["*META-INF/*", "*/module-info.class", "*/OSGI-INF/*.xml", "*/OSGI-INF/*.json", "*spring-configuration-metadata.json", "*checksums.yaml.gz*", "*metadata.gz*", "*data.tar.gz.sig", "*.properties", "*.html"],
"devel_resource_path_exclusions": ["*/tests/*"],
"standard_symbols_to_exclude": [],
"source_symbol_extensions": []
Expand Down
40 changes: 39 additions & 1 deletion scanpipe/tests/pipes/test_d2d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,12 @@ def test_scanpipe_pipes_d2d_java_ignore_pattern(self):
make_resource_file(self.project1, path="to/META-INF/MANIFEST.MF")
make_resource_file(self.project1, path="to/test.class")
make_resource_file(self.project1, path="to/META-INF/others.txt")
make_resource_file(
self.project1, path="to/META-INF/spring-configuration-metadata.json"
)
make_resource_file(self.project1, path="to/OSGI-INF/test.xml")
make_resource_file(self.project1, path="to/OSGI-INF/test.json")
make_resource_file(self.project1, path="to/OSGI-INF/test.class")
buffer = io.StringIO()

java_config = d2d_config.get_ecosystem_config(ecosystem="Java")
Expand All @@ -483,7 +489,7 @@ def test_scanpipe_pipes_d2d_java_ignore_pattern(self):
patterns_to_ignore=java_config.deployed_resource_path_exclusions,
logger=buffer.write,
)
expected = "Ignoring 3 to/ resources with ecosystem specific configurations."
expected = "Ignoring 6 to/ resources with ecosystem specific configurations."
self.assertIn(expected, buffer.getvalue())

def test_scanpipe_pipes_d2d_map_jar_to_java_source(self):
Expand Down Expand Up @@ -584,6 +590,21 @@ def test_scanpipe_pipes_d2d_map_jar_to_scala_source(self):
self.assertEqual(from2, relation.from_resource)
self.assertEqual(to_jar, relation.to_resource)

def test_scanpipe_pipes_d2d_scala_ignore_pattern(self):
make_resource_file(self.project1, path="to/META-INF/MANIFEST.MF")
make_resource_file(self.project1, path="to/test.class")
make_resource_file(self.project1, path="to/META-INF/others.txt")
buffer = io.StringIO()

scala_config = d2d_config.get_ecosystem_config(ecosystem="Scala")
d2d.ignore_unmapped_resources_from_config(
project=self.project1,
patterns_to_ignore=scala_config.deployed_resource_path_exclusions,
logger=buffer.write,
)
expected = "Ignoring 2 to/ resources with ecosystem specific configurations."
self.assertIn(expected, buffer.getvalue())

def test_scanpipe_pipes_d2d_map_jar_to_kotlin_source(self):
from1 = make_resource_file(
self.project1,
Expand Down Expand Up @@ -633,6 +654,23 @@ def test_scanpipe_pipes_d2d_map_jar_to_kotlin_source(self):
self.assertEqual(from2, relation.from_resource)
self.assertEqual(to_jar, relation.to_resource)

def test_scanpipe_pipes_d2d_kotlin_ignore_pattern(self):
make_resource_file(self.project1, path="to/META-INF/test.knm")
make_resource_file(self.project1, path="to/test.class")
make_resource_file(
self.project1, path="to/META-INF/kotlin-project-structure-metadata.json"
)
buffer = io.StringIO()

kotlin_config = d2d_config.get_ecosystem_config(ecosystem="Kotlin")
d2d.ignore_unmapped_resources_from_config(
project=self.project1,
patterns_to_ignore=kotlin_config.deployed_resource_path_exclusions,
logger=buffer.write,
)
expected = "Ignoring 2 to/ resources with ecosystem specific configurations."
self.assertIn(expected, buffer.getvalue())

def test_scanpipe_pipes_d2d_map_jar_to_source_works_for_jar(self):
from1 = make_resource_file(
self.project1,
Expand Down