Skip to content
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

Jump to bottom

Rename run.files to run.artifacts, fileLocation to artifactLocation #309

Closed
michaelcfanning opened this issue Jan 17, 2019 · 3 comments
Closed

Rename run.files to run.artifacts, fileLocation to artifactLocation #309

michaelcfanning opened this issue Jan 17, 2019 · 3 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft e-ballot-2 merged Changes merged into provisional draft. p1 Priority 1 issue to close resolved-fixed

Comments

@michaelcfanning
Copy link
Contributor

I am working with an internal team at MS that is utilizing SARIF for a set of services that provide scanning and scan results. This system operates exclusively against streams, there is nothing in the way of a file system that's involved.

SARIF is used as a kind of message envelope in this system: the team populates it with various SARIF values that the automation system knows about, such as correlation guids, instance ids, etc. The files table is used to specify scan stream targets. In some cases, these streams are downloaded. In other cases, the URIs are provided simply to use as identifiers in results (the request itself contains the scan streams to analyze).

Feedback from this team is that it is strange to constantly populate run.files and fileLocation instances for this scenario. Their suggestion was to make this more general, such as using 'artifact' as an alternate term.

I think we do aspire to have a format that works well in a services environment (this is a primary reason we chose JSON as a format). I'd be fine with this change.

@lgolding
@michaelcfanning michaelcfanning added the p1 Priority 1 issue to close label Jan 24, 2019
@michaelcfanning
Copy link
Contributor Author

TC approves the change.

@michaelcfanning michaelcfanning added the design-approved The TC approved the design and I can write the change draft label Jan 25, 2019
@ghost ghost changed the title Consider: rename run.files to run.artifacts, fileLocation to artifactLocation Rename run.files to run.artifacts, fileLocation to artifactLocation Mar 13, 2019
@michaelcfanning michaelcfanning mentioned this issue Mar 13, 2019
Closed
6 tasks
ghost pushed a commit that referenced this issue Mar 14, 2019
Change draft for #309: file => artifact
6771db9
@ghost
Copy link

ghost commented Mar 14, 2019 •
edited by ghost
Loading

E-BALLOT PROPOSAL

To encourage the use of SARIF by tools that analyzes artifacts that do not exist as files on disk (for example, tools that analyze the responses to web requests), use the term "artifact" in preference to "file" except when a format item really does refer to a file on disk.

SCHEMA CHANGES

  • Rename the file object to artifact.

  • In the renamed artifact object:

    • Rename the fileLocation property to artifactLocation.
    • Rename the following values for the roles property:
      • unmodifiedFile → unmodified.
      • modifiedFile → modified.
      • addedFile → added.
      • deletedFile → deleted.
      • renamedFile → renamed.
      • uncontrolledFile → uncontrolled.

  • Rename the fileLocation object to artifactLocation.

  • In the renamed artifactLocation object:

    • Rename the fileIndex property to artifactIndex.

  • Rename the fileContent object to artifactContent.

  • Rename the fileChange object to artifactChange.

  • In the renamed artifactChange object:

    • Rename the fileLocation property to artifactLocation.

  • In the fix object:

    • Rename the fileChanges property to artifactChanges.

  • In the physicalLocation object:

    • Rename the fileLocation property to artifactLocation.

  • In the run object:

    • Rename the files property to artifacts.
    • Rename the defaultFileEncoding property to defaultEncoding.

ghost pushed a commit that referenced this issue Mar 14, 2019
#309: Move change draft from Accepted to Active.
0985bdd
ghost pushed a commit that referenced this issue Mar 14, 2019
#309: Explain distinction between 'file' and 'artifact'.
a8d760a
ghost pushed a commit that referenced this issue Mar 14, 2019
#309: Fix typos.
8b76eb1
ghost pushed a commit that referenced this issue Mar 14, 2019
Merge changes for #309: file => artifact.
ea3d497
@ghost ghost added 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. merged Changes merged into provisional draft. labels Mar 14, 2019
ghost pushed a commit that referenced this issue Mar 19, 2019
Provide "e-ballot #2" draft.
412c245 
This draft contains all the changes through "e-ballot #2," which
opened on Friday March 15 and will close on Friday March 22. It contains
changes for ballot issues #168, #291, #309, #320, #321, #326, #335,
and #341, as well as for previously approved issue #340.

It does _not_ contain changes for any issues from "e-ballot #3,"
which will open on Friday March 22 and close on Friday March 29.
@ghost ghost self-assigned this Mar 29, 2019
@ghost
Copy link

ghost commented Mar 29, 2019

Approved in e-ballot #2.

@ghost ghost closed this as completed Mar 29, 2019
llvm-git-migration pushed a commit to llvm/llvm-project that referenced this issue Aug 27, 2019
@jranieri-grammatech
Update the SARIF exporter to SARIF 2.1
fce4324 
This updates the SARIF exporter to produce SARIF 2.1 output. The bulk of the diffs come from two changes to SARIF:
* oasis-tcs/sarif-spec#309
* oasis-tcs/sarif-spec#179

Differential Revision: https://reviews.llvm.org/D65211

llvm-svn: 370068
spurious pushed a commit to spurious/clang-mirror that referenced this issue Aug 27, 2019
Update the SARIF exporter to SARIF 2.1
f83401c 
This updates the SARIF exporter to produce SARIF 2.1 output. The bulk of the diffs come from two changes to SARIF:
* oasis-tcs/sarif-spec#309
* oasis-tcs/sarif-spec#179

Differential Revision: https://reviews.llvm.org/D65211


git-svn-id: http://llvm.org/svn/llvm-project/cfe/trunk@370068 91177308-0d34-0410-b5e6-96231b3b80d8
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft e-ballot-2 merged Changes merged into provisional draft. p1 Priority 1 issue to close resolved-fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@michaelcfanning