Skip to content

Update shared_tests README #110

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

Open
aufi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update shared_tests README #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions shared_tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,7 @@ Component test suites that should use those shared tests are:
└── test_cases.yaml # analysis test cases definition (top level keys should match to directory names with expected results)
Copy link

@coderabbitai coderabbitai bot Aug 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix extension mismatch: use test_cases.yml consistently.

The tree lists test_cases.yaml, but the link and PR objective point to test_cases.yml. Standardize on .yml to match the PR intent and avoid confusion.

Apply this diff:

-    └── test_cases.yaml          # analysis test cases definition (top level keys should match to directory names with expected results)
+    └── test_cases.yml           # analysis test cases definition (top level keys should match directory names with expected results)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
└── test_cases.yaml # analysis test cases definition (top level keys should match to directory names with expected results)
└── test_cases.yml # analysis test cases definition (top level keys should match directory names with expected results)
🤖 Prompt for AI Agents 
In shared_tests/README.md at line 17, the filename extension for the test cases
file is listed as .yaml, but the rest of the PR and links use .yml. Change the
filename in the tree listing from test_cases.yaml to test_cases.yml to maintain
consistency and avoid confusion.

Copy link
Contributor

@mguetta1 mguetta1 Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link

@coderabbitai coderabbitai bot Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mguetta1 Thank you for confirming! The extension standardization will help maintain consistency in the documentation.

ᕕ( ᐛ )ᕗ

If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!

```

```
# tc.yaml
---
description: <description of the test, could be just name of the app or more detailed>
input: <input application to be analyzed, absolute link to e.g. github or local path for binary relative to this file>
sources: <array of sources, use [] if empty>
targets: <array of targets, use [] if empty>
options: <optional array of name,value pairs, e.g. for maven settings file and other advanced options>
# Example:
#- name: maven-settings
# value: ./settings.yaml

```

Check out [book-server test case](analysis_book-server/) as an example.
Check out [test cases.yml](test_cases.yml)
Copy link

@coderabbitai coderabbitai bot Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Align link text with actual filename and clarify.

Use the exact filename in the link text for clarity and consistency with the tree.

Apply this diff:

-Check out [test cases.yml](test_cases.yml)
+See [test_cases.yml](test_cases.yml) for the canonical test case definition.

Run this script to verify there are no stale references and confirm which file exists:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Searching for stale references to tc.yaml..."
rg -n --hidden --glob '!.git' 'tc\.ya?ml' || true

echo -e "\nListing test_cases files present in the repo..."
fd -a 'test_cases.y*ml' || true

echo -e "\nScanning for references to test_cases.yml/.yaml in the repo..."
rg -n --hidden --glob '!.git' 'test_cases\.ya?ml' || true

Length of output: 1559

Align README references to the actual filename and clarify.

  • In shared_tests/README.md line 17, the tree listing shows test_cases.yaml but the file on disk is test_cases.yml. Update it for consistency: 
    

    • 



-└── test_cases.yaml          # analysis test cases definition …

+└── test_cases.yml           # analysis test cases definition …


- In the same file at line 20, use the exact filename in the link text and clarify its purpose:
```diff
-Check out [test cases.yml](test_cases.yml)
+See [test_cases.yml](test_cases.yml) for the canonical test case definition.



Run the provided validation script to ensure there are no stale tc.yaml references and that all test_cases.yml links resolve correctly.




📝 Committable suggestion



‼️ IMPORTANT

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.



  

    

      

        Suggested change
      

    

    

      

          

            
            Check out [test cases.yml](test_cases.yml)
          

          

            
            └── test_cases.yml          # analysis test cases definition …
          

          

            
            
          

          

            
            See [test_cases.yml](test_cases.yml) for the canonical test case definition.
          

      

    

    

  







🤖 Prompt for AI Agents

In shared_tests/README.md at line 20, update the link text from "test cases.yml"
to "test_cases.yml" to match the actual filename exactly and clarify its
purpose, ensuring consistency with the file on disk and the earlier tree
listing. Adjust the link text to be precise and descriptive about the file it
references.






    

  
  




    


        

      
  
  

    
  
    
    

  

  

  



          

              

      








    


  









  


    


  		



    

    

    

  
    







    

    

    

  
    ## Notes






    

    

    

  
    







  

    
          
            
          
          Expand Down
    
    
  



                
              


          


    

  







    

  
  
    
      Loading