@@ -27,8 +27,8 @@ const (
2727)
2828
2929const (
30- JfrogCliSummaryDir = "jfrog-command-summary "
31- MarkdownFileName = "markdown.md "
30+ markdownFileName = "markdown.md "
31+ finalSarifFileName = "final.sarif "
3232)
3333
3434var markdownSections = []MarkdownSection {Security , BuildInfo , Upload }
@@ -37,13 +37,22 @@ func (ms MarkdownSection) String() string {
3737 return string (ms )
3838}
3939
40- // GenerateSummaryMarkdown creates a summary of recorded CLI commands in Markdown format .
41- func GenerateSummaryMarkdown (c * cli.Context ) error {
40+ // Generates a combined markdown from all sections, and aggregates multiple SARIF files into one .
41+ func FinalizeCommandSummaries (c * cli.Context ) error {
4242 if ! shouldGenerateSummary () {
4343 return fmt .Errorf ("unable to generate the command summary because the output directory is not specified." +
4444 " Please ensure that the environment variable '%s' is set before running your commands to enable summary generation" , coreutils .SummaryOutputDirPathEnv )
4545 }
4646
47+ if err := generateSummaryMarkdown (c ); err != nil {
48+ return err
49+ }
50+
51+ return aggregatedCodeScanningSarifs ()
52+ }
53+
54+ // generateSummaryMarkdown creates a summary of recorded CLI commands in Markdown format.
55+ func generateSummaryMarkdown (c * cli.Context ) error {
4756 // Get URL and Version to generate summary links
4857 serverUrl , majorVersion , err := extractServerUrlAndVersion (c )
4958 if err != nil {
@@ -71,6 +80,26 @@ func GenerateSummaryMarkdown(c *cli.Context) error {
7180 return saveMarkdownToFileSystem (finalMarkdown )
7281}
7382
83+ func aggregatedCodeScanningSarifs () error {
84+ files , err := getSarifFiles ()
85+ if err != nil {
86+ return err
87+ }
88+ if len (files ) == 0 {
89+ log .Debug ("No sarif reports were found" )
90+ return nil
91+ }
92+ finalSarif , err := securityUtils .CombineSarifOutputFiles (files )
93+ if err != nil {
94+ return err
95+ }
96+ return saveFinalSarifToFileSystem (string (finalSarif ))
97+ }
98+
99+ func getSarifReportsDir () string {
100+ return filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), commandsummary .OutputDirName , string (Security ), string (commandsummary .SarifReport ))
101+ }
102+
74103// The CLI generates summaries in sections, with each section as a separate Markdown file.
75104// This function merges all sections into a single Markdown file and saves it in the root of the
76105// command summary output directory.
@@ -93,23 +122,29 @@ func saveMarkdownToFileSystem(finalMarkdown string) (err error) {
93122 if finalMarkdown == "" {
94123 return nil
95124 }
96- filePath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), JfrogCliSummaryDir , MarkdownFileName )
125+ filePath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), commandsummary .OutputDirName , markdownFileName )
126+ return saveFile (finalMarkdown , filePath )
127+ }
128+
129+ func saveFile (content , filePath string ) (err error ) {
130+ if content == "" {
131+ return nil
132+ }
97133 file , err := os .Create (filePath )
98134 if err != nil {
99- return fmt . Errorf ( "error creating markdown file: %w" , err )
135+ return err
100136 }
101137 defer func () {
102138 err = errors .Join (err , file .Close ())
103139 }()
104- // Write to file
105- if _ , err := file .WriteString (finalMarkdown ); err != nil {
106- return fmt .Errorf ("error writing to markdown file: %w" , err )
140+ if _ , err = file .WriteString (content ); err != nil {
141+ return err
107142 }
108143 return nil
109144}
110145
111146func getSectionMarkdownContent (section MarkdownSection ) (string , error ) {
112- sectionFilepath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), JfrogCliSummaryDir , string (section ), MarkdownFileName )
147+ sectionFilepath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), commandsummary . OutputDirName , string (section ), markdownFileName )
113148 if _ , err := os .Stat (sectionFilepath ); os .IsNotExist (err ) {
114149 return "" , nil
115150 }
@@ -124,6 +159,23 @@ func getSectionMarkdownContent(section MarkdownSection) (string, error) {
124159 return string (contentBytes ), nil
125160}
126161
162+ func getSarifFiles () (files []string , err error ) {
163+ indexedFiles , err := commandsummary .GetIndexedDataFilesPaths ()
164+ if err != nil {
165+ return
166+ }
167+ sarifsMap := indexedFiles [commandsummary .SarifReport ]
168+ for i := range sarifsMap {
169+ files = append (files , sarifsMap [i ])
170+ }
171+ return
172+ }
173+
174+ func saveFinalSarifToFileSystem (finalSarif string ) (err error ) {
175+ filePath := filepath .Join (getSarifReportsDir (), finalSarifFileName )
176+ return saveFile (finalSarif , filePath )
177+ }
178+
127179// Initiate the desired command summary implementation and invoke its Markdown generation.
128180func invokeSectionMarkdownGeneration (section MarkdownSection ) error {
129181 switch section {
@@ -151,7 +203,7 @@ func generateBuildInfoMarkdown() error {
151203 if err != nil {
152204 return fmt .Errorf ("error generating build-info markdown: %w" , err )
153205 }
154- if err = mapScanResults (buildInfoSummary ); err != nil {
206+ if err = mapScanResults (); err != nil {
155207 return fmt .Errorf ("error mapping scan results: %w" , err )
156208 }
157209 return buildInfoSummary .GenerateMarkdown ()
@@ -170,9 +222,9 @@ func generateUploadMarkdown() error {
170222}
171223
172224// mapScanResults maps the scan results saved during runtime into scan components.
173- func mapScanResults (commandSummary * commandsummary. CommandSummary ) (err error ) {
225+ func mapScanResults () (err error ) {
174226 // Gets the saved scan results file paths.
175- indexedFiles , err := commandSummary .GetIndexedDataFilesPaths ()
227+ indexedFiles , err := commandsummary .GetIndexedDataFilesPaths ()
176228 if err != nil {
177229 return err
178230 }
@@ -216,7 +268,7 @@ func processScan(index commandsummary.Index, filePath string, scannedName string
216268
217269// shouldGenerateUploadSummary checks if upload summary should be generated.
218270func shouldGenerateUploadSummary () (bool , error ) {
219- buildInfoPath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), JfrogCliSummaryDir , string (BuildInfo ))
271+ buildInfoPath := filepath .Join (os .Getenv (coreutils .SummaryOutputDirPathEnv ), commandsummary . OutputDirName , string (BuildInfo ))
220272 if _ , err := os .Stat (buildInfoPath ); os .IsNotExist (err ) {
221273 return true , nil
222274 }
0 commit comments