chore: display a unique interaction id alongside each error

[sandor-trombitas]

Pull Request Submission Checklist

• Follows CONTRIBUTING guidelines
• Includes detailed description of changes
• Contains risk assessment (Low)
• Highlights breaking API changes (if applicable)
• Links to automated tests covering new functionality
• Includes manual testing instructions (if necessary)
• Updates relevant GitBook documentation (PR link: ___)

What does this PR do?

Adds the interaction id to the rendered error when a scan fails

Where should the reviewer start?

review the changes in gaf

How should this be manually tested?

run a test that is expect to fail, eg:

Screenshots

Example of new general CLI failure Error Catalog output:

 ERROR   Unspecified Error (SNYK-CLI-0000)
         The encountered error only provides basic information, please take a look at   
         the given details.If they do not help to resolve the issue, consider debugging 
         or consulting support.                                                         
                                                                                        
           Must set `--format` flag to specify an SBOM format. Available formats are:     
           cyclonedx1.4+json, cyclonedx1.4+xml, cyclonedx1.5+json, cyclonedx1.5+xml,      
           cyclonedx1.6+json, cyclonedx1.6+xml, spdx2.3+json                              
Docs:    https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0000 
         https://docs.snyk.io/snyk-cli/commands                          
         https://docs.snyk.io/snyk-cli/debugging-the-snyk-cli       

ID:  urn:snyk:interaction:<UUID>                                                              

Example of specific Error Catalog error output:

 ERROR   Authentication error (SNYK-0005)
         Authentication credentials not recognized, or user access is not provisioned.  
         Revise credentials and try again, or request access from your Snyk             
         administrator.                                                                 
                                                                                        
           Use `snyk auth` to authenticate.                                               
                          
Status:  401 Unauthorized                                                                    
Docs:    https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0005

ID:  urn:snyk:interaction:<UUID>                        

[PeterSchafer]

The PR title says feat, the commit says chore. Let's settle on chore please! And add something meaningful.

[github-actions]

	Warnings
⚠️	There are multiple commits on your branch, please squash them locally before merging!
⚠️	"chore(deps): upgrade go-application-framework@04faf47716bb0f1a05801823b7a851e33c6dbd5f" is too long. Keep the first line of your commit message under 72 characters.
⚠️	"chore: restore original assertions add in validation of metadata behaviour" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against 3314c9e

[PeterSchafer]

Question: Showing the a single InteractionId can also be achieved in OutputError() and would keep the concerns of presenting errors separated from the orchestration logic in main. Is there a reason not to adapt OutputError() so that it can also work for multiple errors at time point in the future?

[PeterSchafer]

After syncing, we decided to wait for design input and then see what is the best way to continue.

[PeterSchafer]

Issue: I think the current changes lost a new line, for example when running snyk sbom --format cyclonedx1.4+json --file=./foldernotthere

ERROR   Unspecified Error (SNYK-CLI-0000)
         The encountered error only provides basic information, please take a look at
         the given details.If they do not help to resolve the issue, consider debugging
         or consulting support.

           An error occurred while running the underlying analysis needed to generate
           the SBOM.
Docs:    https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0000
         https://docs.snyk.io/snyk-cli/commands
         https://docs.snyk.io/snyk-cli/debugging-the-snyk-cli

ID: urn:snyk:interaction:78ba05be-1f33-4432-b51e-786ee77939b7

Before docs there should be a separator.