Repository navigation
taint analysis example - #1369
Closed
SamarthBengle wants to merge 9 commits into
Closed
SamarthBengle wants to merge 9 commits into
SamarthBengle wants to merge 9 commits into
Conversation
swissiety
reviewed
Aug 22, 2025
swissiety
left a comment
swissiety
left a comment
Collaborator
There was a problem hiding this comment.
ok - please add a step by step guide "tutorial" written in markdown.
- write tutorial
- add a new file in docs/ .
- To include the code example please make use of a plugin that lets you include files so that you can refer to specific lines/code range in the TaintAnalysisTest.java file so that the mentioned lines are included in the markdown rendering (find/configure a mkdocs plugin if necessary) - maybe a mkdocs plugin that lets you specify code regions by a placeholder in a code comment which we could insert into the original source would be really great so the ranges would not changes if someone adds anew line of code.
swissiety
requested changes
Sep 19, 2025
swissiety
left a comment
swissiety
left a comment
Collaborator
There was a problem hiding this comment.
lets make use of a mkdocs plugin to import the sections from a .java file
| The core analysis logic extends `DefaultJimpleIFDSTabulationProblem`: | ||
|
|
||
| ```java | ||
| static class TaintAnalysisProblem extends DefaultJimpleIFDSTabulationProblem<Object, InterproceduralCFG<Stmt, SootMethod>> { |
Collaborator
There was a problem hiding this comment.
can we break that huge section down into multiple smaller ones + explaination?
…mple # Conflicts: # mkdocs.yml
Address review of soot-oss#1369: - docs/taint-analysis-example.md no longer copies code; every Java block is included from TaintAnalysisTest.java via named `--8<--` sections, so the tutorial always shows compiled and tested code. check_paths fails the docs build if a section goes missing. - Use pymdownx.snippets (already enabled, shipped with mkdocs-material) instead of the codeinclude plugin, which the docs CI does not install. - Remove CodeBlockExtractor and the sync-examples workflow (out of scope). - Update TaintAnalysisTest to the current SootUp API, propagate taint through call sites with a return value (b = id(a)) and assert the expected leak / no-leak verdict per scenario instead of swallowing all results. - Split the tutorial into small sections, each with an explanation; fix the dependency snippet.
Collaborator
|
integrated into #1629 |
swissiety
added a commit
that referenced
this pull request
Sep 24, 2026
Moves the tutorial next to the other analysis examples under "How to.." and keeps base_path/check_paths while adding dedent_subsections.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1369 +/- ##
=============================================
- Coverage 72.64% 72.59% -0.05%
Complexity 238 238
=============================================
Files 488 488
Lines 20820 20820
Branches 3400 3400
=============================================
- Hits 15124 15115 -9
- Misses 4385 4390 +5
- Partials 1311 1315 +4
🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.