Skip to content

Added v2 to v3 result transformation that includes package changes #1079

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
andrecsilva merged 3 commits into from
Jul 8, 2025
Merged

Added v2 to v3 result transformation that includes package changes #1079

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c0f322
Added v2 to v3 transformation that includes package changes
andrecsilva Jul 4, 2025
fba9cff
Changed debug message
andrecsilva Jul 7, 2025
4c5cfe6
Bugfixes and added parameters for generation metadata
andrecsilva Jul 7, 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
45 changes: 45 additions & 0 deletions src/codemodder/codetf/v3/codetf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@

from pydantic import BaseModel, model_validator

from codemodder.logging import logger

from ..common import Change, CodeTFWriter, Finding, FixQuality
from ..v2.codetf import AIMetadata as AIMetadatav2
from ..v2.codetf import ChangeSet as v2ChangeSet
from ..v2.codetf import CodeTF as CodeTFv2
from ..v2.codetf import Result
from ..v2.codetf import Run as Runv2
Expand Down Expand Up @@ -148,6 +151,48 @@ def from_v2_aimetadata(ai_metadata: AIMetadatav2) -> AIMetadata:
)


def from_v2_result_per_finding(result: Result) -> FixResult | None:
"""
This transformation assumes that the v2 result will only contain a single fixedFinding for all changesets.
"""
# Find the changeset with a fixedFinding
try:
changeset: v2ChangeSet = next(cs for cs in result.changeset if cs.fixedFindings)
Copy link
Member

@drdavella drdavella Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed findings can belong to individual Change entries of a change set as well, so you need to check there too, both here and below.

Copy link
Contributor Author

@andrecsilva andrecsilva Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are usually replicated. That is, the changeset fixedFindings should always include the ones contained in the changes.

I'll make it check each individual change in any case.

except StopIteration:
logger.debug("Either no changesets or no fixedFinding in the given Result")
return None

assert changeset.fixedFindings
finding = changeset.fixedFindings[0]

v3changesets = [
ChangeSet(
path=cs.path, diff=cs.diff, changes=[c.to_common() for c in cs.changes]
)
for cs in result.changeset
]

generation_metadata = GenerationMetadata(
strategy=Strategy.ai if changeset.ai else Strategy.deterministic,
ai=from_v2_aimetadata(changeset.ai) if changeset.ai else None,
provisional=False,
Copy link
Contributor

@clavedeluna clavedeluna Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will this function always be called from non-provisional contexts?

Copy link
Contributor Author

@andrecsilva andrecsilva Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No clue, not sure why this flag exists in the first place.

Copy link
Contributor

@clavedeluna clavedeluna Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

provisional=True is "magic"... maybe we no longer make this distinction ?

Copy link
Member

@drdavella drdavella Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be derived from the v2 changeset the same way as these other metadata fields.

Suggested change
provisional=False,
provisional=changeset.provisional,

Copy link
Member

@drdavella drdavella Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any chance that for our purposes it makes more sense to pass in these metadata fields as parameters to this new function? For the use case I'm thinking of, I'd argue that the answer is yes.

)

fix_metadata = FixMetadata(
id=result.codemod,
summary=result.summary,
description=result.description,
generation=generation_metadata,
)

return FixResult(
finding=Finding(**finding.model_dump()),
fixStatus=FixStatus(status=FixStatusType.fixed),
changeSets=v3changesets,
fixMetadata=fix_metadata,
)


def from_v2_result(result: Result) -> list[FixResult]:
fix_results: list[FixResult] = []
# generate fixed
Expand Down
127 changes: 126 additions & 1 deletion tests/test_codetf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@
Strategy,
)
from codemodder.codetf.v3.codetf import Finding as FindingV3
from codemodder.codetf.v3.codetf import FixStatusType, from_v2, from_v2_result
from codemodder.codetf.v3.codetf import (
FixStatusType,
from_v2,
from_v2_result,
from_v2_result_per_finding,
)


@pytest.fixture(autouse=True)
Expand Down Expand Up @@ -259,6 +264,126 @@ def test_v2_result_to_v3():
assert from_v2_result(result)


def test_v2_result_to_v3_per_finding():
result = Result(
codemod="codeql:java/log-injection",
summary="Introduced protections against Log Inject ion / Forging attacks",
description='This change ensures that log messages can\'t contain newline characters, leaving you vulnerable to Log Forging / Log Injection.\n\nIf malicious users can get newline characters into a log message, they can inject and forge new log entries that look like they came from the server, and trick log analysis tools, administrators, and more . This leads to vulnerabilities like Log Injection, Log Forging, and more attacks from there.\n\nOur change simply strips out newline characters from log messages, ensuring that they can \'t be used to forge new log entries.\n```diff\n+ import io.github.pixee.security.Newlines;\n ...\n String orderId = getUserOrderId();\n- log.info("User order ID: " + orderId);\n+ log. info("User order ID: " + Newlines.stripNewlines(orderId));\n```\n',
detectionTool=DetectionTool(name="CodeQL"),
references=[
Reference(
url="https://owasp.org/www-community/attacks/Log_Inj ection",
description="https://owasp.org/www-community/attacks/Log_Injection",
),
Reference(
url="https://knowledge-base.secureflag.com/vulnerabilities/inadequate_input_validation/log_inject ion_vulnerability.html",
description="https://knowledge-base.secureflag.com/vulnerabilities/inadequate_input_validation/log_injection_vulnerability.html",
),
Reference(
url="https://cwe.mit re.org/data/definitions/117.html",
description="https://cwe.mitre.org/data/definitions/117.html",
),
],
properties={},
failedFiles=[],
changeset=[
ChangeSet(
path="app/src/main/java/org/apache/roller/planet/business/fetcher/RomeFeedFetcher.java",
diff='--- RomeFeedFetcher.java\n+++ RomeFeedFetcher.java\n@@ -26,6 +26,7 @@\n import com.rometools.rome.io.FeedException;\n import com.rometools.rome.io.SyndFeedInput;\n import com.rometools.rome.io.XmlReader;\n+import static io.github.pixee.security.Newlines.stripAll;\n \n import java.io.IOException;\n import java.net.URI;\n@@ -123,7 +124,7 @@\n }\n \n if(log.isDebugEnabled()) {\n- log.debug("Subscription is: " + newSub.toString());\n+ log.debug("Subscription is: " + stripAll(newSub.toString()));\n }\n \n ',
changes=[
Change(
lineNumber=126,
description="Added a call to replace any newlines the value",
diffSide=DiffSide.LEFT,
properties={},
packageActions=[
PackageAction(
action=Action.ADD,
result=PackageResult.COMPLETED,
package="pkg:maven/io.github.pixee/[email protected]",
),
PackageAction(
action=Action.ADD,
result=PackageResult.COMPLETED,
package="pkg:maven/io.github.pixee/[email protected]",
),
],
fixedFindings=[
Finding(
id="915a8320-3ee8-4b0e-849b-c1b380fb83e2",
rule=Rule(
id="log-injection",
name="Log Injection",
url="https://codeql.github.com/codeql-query-help/java/java-log-injection/",
),
)
],
)
],
ai=None,
strategy=Strategy.deterministic,
provisional=False,
fixedFindings=[
Finding(
id="915a8320-3ee8-4b0e-849b-c1b380fb83e2",
rule=Rule(
id="log-injection",
name="Log Injection",
url="https://codeql.github.com/codeql-query-help/java/java-log-injection/",
),
)
],
fixQuality=None,
),
ChangeSet(
path="app/pom.xml",
diff="--- app/pom.xml\n+++ app/pom.xml\n@@ -591,9 +591,12 @@\n <version>5.3.0</version>\n <scope>test</scope>\n </dependency>\n+ <dependency>\n+ <groupId>io.github.pixee</groupId>\n+ <artifactId>java-security-toolkit</artifactId>\n+ </dependency>\n+ </dependencies>\n \n- </dependencies>\n-\n <build>\n \n <finalName>roller</finalName>",
changes=[
Change(
lineNumber=594,
description="This library holds security tools for protecting Java API calls.\n\nLicense: MIT ✅ | [Open source](https://github.com/pixee/java-security-toolkit) ✅ | [More facts](https://mvnrepository.com/artifact/io.github.pixee/java-security-toolkit/1.2.2)\n",
diffSide=DiffSide.RIGHT,
properties={"contextual_description": "true"},
packageActions=[],
fixedFindings=[],
)
],
ai=None,
strategy=Strategy.deterministic,
provisional=False,
fixedFindings=[],
fixQuality=None,
),
ChangeSet(
path="pom.xml",
diff="--- pom.xml\n+++ pom.xml\n@@ -48,7 +48,8 @@\n <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>\n <roller.version>6.1.5</roller.version>\n <slf4j.version>1.7.36</slf4j.version>\n- </properties>\n+ <versions.java-security-toolkit>1.2.2</versions.java-security-toolkit>\n+ </properties>\n \n <modules>\n <module>app</module>\n@@ -110,7 +111,12 @@\n <version>5.11.4</version>\n <scope>test</scope>\n </dependency>\n- </dependencies>\n+ <dependency>\n+ <groupId>io.github.pixee</groupId>\n+ <artifactId>java-security-toolkit</artifactId>\n+ <version>${versions.java-security-toolkit}</version>\n+ </dependency>\n+ </dependencies>\n </dependencyManagement>\n \n </project>",
changes=[
Change(
lineNumber=114,
description="This library holds security tools for protecting Java API calls.\n\nLicense: MIT ✅ | [Open source](https://github.com/pixee/java-security-toolkit) ✅ | [More facts](https://mvnrepository.com/artifact/io.github.pixee/java-security-toolkit/1.2.2)\n",
diffSide=DiffSide.RIGHT,
properties={"contextual_description": "true"},
packageActions=[],
fixedFindings=[],
)
],
ai=None,
strategy=Strategy.deterministic,
provisional=False,
fixedFindings=[],
fixQuality=None,
),
],
unfixedFindings=[],
)
fix_result = from_v2_result_per_finding(result)
assert fix_result
assert len(fix_result.changeSets) == 3
all_paths = {cs.path for cs in fix_result.changeSets}
assert "app/pom.xml" in all_paths
assert "pom.xml" in all_paths


def test_v2_to_v3_conversion():
with open("tests/samples/codetfv2_sample.codetf", "r") as f:
codetfv2 = CodeTF.model_validate_json(f.read())
Expand Down
Loading