xref: /aosp_15_r20/external/licenseclassifier/v2/scenarios/README.md (revision 46c4c49da23cae783fa41bf46525a6505638499a)
1*46c4c49dSIbrahim Kanouche# Scenarios
2*46c4c49dSIbrahim Kanouche
3*46c4c49dSIbrahim KanoucheTest scenarios are files with a predefined structure for running tests.
4*46c4c49dSIbrahim Kanouche
5*46c4c49dSIbrahim KanoucheA scenario should have some text describing what is being tested and why.
6*46c4c49dSIbrahim KanoucheFollowing the description, the keyword EXPECTED followed by a colon and a
7*46c4c49dSIbrahim Kanouchecomma-separated list of expected licenses should appear, concluding with an
8*46c4c49dSIbrahim Kanoucheendline. All remaining content in the file is passed as input to the classifier.
9*46c4c49dSIbrahim Kanouche
10*46c4c49dSIbrahim KanoucheFilenames are generally the Buganizer id, suffixed with an underscore and
11*46c4c49dSIbrahim Kanouchenumbers if there are multiple scenarios necessary for a bug.
12*46c4c49dSIbrahim Kanouche
13*46c4c49dSIbrahim KanoucheAs an example:
14*46c4c49dSIbrahim Kanouche
15*46c4c49dSIbrahim Kanouche```
16*46c4c49dSIbrahim KanoucheThis is a simple license header that we did not previously detect due
17*46c4c49dSIbrahim Kanoucheto b/12345
18*46c4c49dSIbrahim KanoucheEXPECTED:ISC
19*46c4c49dSIbrahim Kanouche<code content goes here>
20*46c4c49dSIbrahim Kanouche```
21*46c4c49dSIbrahim Kanouche
22*46c4c49dSIbrahim KanoucheScenarios should not be encumbered by license restrictions, so it's essential to
23*46c4c49dSIbrahim Kanouchecreate a minimal reproduction that doesn't rely on licensed code.
24