Quality Gate tells you at every analysis whether your is tested enough to be released

Ponicode SQUAR GitHub Action is an action that enables you to grade the test quality of your project and provide you with a precise and activatable improvements roadmap at every Pull request!

Combined with Ponicode Unit Test Action, you can immediately implement the SQUAR roadmap and get instantaneous coverage catch-up

Tackle your code quality issues in the right order to:

• GAIN VISIBILITY - Get instant feedback of the quality of your tests everytime you change your code
• PRIORITIZED BACKLOG - Get a detailed and prioritized list of action you need to take to increase your test quality
• RAISE YOUR CODE QUALITY FAST - Accelerate the remediation of your code quality weaknesses on your high risk functions (When Ponicode SQUAR action is combined with Ponicode Unit-Testing Action)

• Step 1: Ponicode SQUAR GitHub Action generates a report for every PR where you can review the number of poorly tested critical functions and learn how to fix it.
• Step 2: Ponicode SQUAR GitHub Action enables you to accelerate the remediation of these weaknesses by generating missing unit tests, test cases and edge cases on your PR (When Ponicode SQUAR action is combined with Ponicode Unit Test Action)

• Keep your risk sensitive code at a high test coverage
• Avoids weaknesses from the most important function
• Reduce the chances of facing bugs in production

Add the following lines to any of your Github Action workflow.

Go to the root of your project, and create the path to your workflow file. For example

mkdir -p .github/workflows

You can also just create a folder named .github, in it create another folder named workflows. You can now create a YAML file named ponicode.yml and copy one of the following examples in it!

Here is what you must add in your .github/workflows/ponicode.yml file to activate and use Ponicode SQUAR Action to trigger the action, including the immediate remediation implementation with Ponicode Unit Test Action.

jobs:
  ponicode:
    runs-on: ubuntu-latest
    env:
      SQUAR_API_URL: "https://ponicode-glados-prod.azurewebsites.net"
      FETCH_REPORT_RETRY_MILLISEC: 5000
    steps:
    - uses: actions/checkout@v1
    - run: |
        npm install -g ponicode
    
    # Identify which files are impacted by the Push / PR
    - id: get_changed_files
      uses: jitterbit/get-changed-files@v1
      continue-on-error: true
      with:
        format: 'json'

    # Extract branch name
    - id: extract_branch
      if: github.event_name == 'pull_request'
      run: echo "::set-output name=BRANCH_NAME::$(echo ${GITHUB_HEAD_REF})"
    
    # Run Ponicode SQUAR action
    - uses: ponicode/squar_action@master
      id: ponicode_squar
      with:
        repoURL: ${{github.repository}} # DO NOT MODIFY
        impactedFiles: ${{ steps.get_changed_files.outputs.added_modified }} # DO NOT MODIFY
        branch: ${{ steps.extract_branch.outputs.BRANCH_NAME }} # DO NOT MODIFY
        githubToken: ${{ secrets.GITHUB_TOKEN }} # DO NOT MODIFY
        ponicodeSquarToken: ${{ secrets.PONICODE_SQUAR_TOKEN }} # DO NOT MODIFY
        displayFullReport: 'true'   

1. grades the code contained into the created / updated PR, and lists the alerts (= functions introduced / updated in the PR that are not / not-well tested)
2. optionaly (if displayFullReport parameter is set to true): displays the SQUAR report for the whole project
3. bootstraps the (missing) unit-tests for the functions included in the PR into a dedicated new PR.

NB: all the other parameters must be let un-changed, since they are automatically filled-in from previous steps in the workflow

• repoURL
• impactedFiles
• branch
• githubToken

NB2: you can find the procedure on how to setup Github Secrets here: Github Secrets setup. Here is an overview:

To add the Ponicode token to your github secrets follow these steps:

• Open your project on Github
• Click on Settings
• Click on Secrets
• Click on New Secret
• Name: PONICODE_SQUAR_TOKEN, Value: (Paste the token you got previously)

Ponicode SQUAR Action outputs

Here are some examples of .github/workflows/ponicode.yml file to setup Ponicode SQUAR Action

name: "ponicode-ci"
on:
  pull_request:
    types: [ opened, edited, synchronize ]  # rebuild any PRs and main branch changes

jobs:
  ponicode:
    runs-on: ubuntu-latest
    env:
      SQUAR_API_URL: "https://ponicode-glados-prod.azurewebsites.net"
      FETCH_REPORT_RETRY_MILLISEC: 5000
    steps:
    - uses: actions/checkout@v1
    - run: |
        npm install -g ponicode
    
    # Identify which files are impacted by the Push / PR
    - id: get_changed_files
      uses: jitterbit/get-changed-files@v1
      continue-on-error: true
      with:
        format: 'json'

    # Extract branch name
    - id: extract_branch
      if: github.event_name == 'pull_request'
      run: echo "::set-output name=BRANCH_NAME::$(echo ${GITHUB_HEAD_REF})"
    
    # Run Ponicode SQUAR action
    - uses: ponicode/squar_action@master
      id: ponicode_squar
      with:
        repoURL: ${{github.repository}} # DO NOT MODIFY
        impactedFiles: ${{ steps.get_changed_files.outputs.added_modified }} # DO NOT MODIFY
        branch: ${{ steps.extract_branch.outputs.BRANCH_NAME }} # DO NOT MODIFY
        githubToken: ${{ secrets.GITHUB_TOKEN }} # DO NOT MODIFY
        ponicodeSquarToken: ${{ secrets.PONICODE_SQUAR_TOKEN }} # DO NOT MODIFY
        displayFullReport: 'true'

    # Run Ponicode Unit-Testing action
    - uses: ponicode/unit-testing-action@master
      id: ponicode_unit_testing
      with:
        repoURL: ${{github.repository}} # DO NOT MODIFY
        branch: ${{ steps.extract_branch.outputs.BRANCH_NAME }} # DO NOT MODIFY
        githubToken: ${{ secrets.GITHUB_TOKEN }} # DO NOT MODIFY
        ponicodeUtToken: ${{ secrets.PONICODE_TOKEN }} # DO NOT MODIFY
        impactedFiles: ${{ steps.ponicode_squar.outputs.impacted_files }} # DO NOT MODIFY IF YOU WANT TO GENERATE TESTS ON SQUAR OUTCOME ONLY
        commentUTs: "true"

name: "ponicode-ci"
on:
  pull_request:
    types: [ opened, edited, synchronize ]  # rebuild any PRs and main branch changes

jobs:
  ponicode:
    runs-on: ubuntu-latest
    env:
      SQUAR_API_URL: "https://ponicode-glados-prod.azurewebsites.net"
      FETCH_REPORT_RETRY_MILLISEC: 5000
    steps:
    - uses: actions/checkout@v1
    - run: |
        npm install -g ponicode
    
    # Identify which files are impacted by the Push / PR
    - id: get_changed_files
      uses: jitterbit/get-changed-files@v1
      continue-on-error: true
      with:
        format: 'json'

    # Extract branch name
    - id: extract_branch
      if: github.event_name == 'pull_request'
      run: echo "::set-output name=BRANCH_NAME::$(echo ${GITHUB_HEAD_REF})"
    
    # Run Ponicode SQUAR action
    - uses: ponicode/squar_action@master
      id: ponicode_squar
      with:
        repoURL: ${{github.repository}} # DO NOT MODIFY
        impactedFiles: ${{ steps.get_changed_files.outputs.added_modified }} # DO NOT MODIFY
        branch: ${{ steps.extract_branch.outputs.BRANCH_NAME }} # DO NOT MODIFY
        githubToken: ${{ secrets.GITHUB_TOKEN }} # DO NOT MODIFY
        ponicodeSquarToken: ${{ secrets.PONICODE_SQUAR_TOKEN }} # DO NOT MODIFY
        displayFullReport: 'true'

Ponicode research and development work enables us to fine tune a proprietary formula to spot the most important functions of your codebase. This formula is based on how much of an impact the function has on the overall behavior of your application. This translates into getting a better visibility over how likely a weakness in a function could generate an impactful bug for your software. Still unsure about what makes a high risk function? Here’s 2 weighted elements we put into our equation.

• Complexity to Repair: Measure of how difficult a function is to intuitively understand and modify. This measure is between 0 and 1
• Impact of a function on the code-base: Measure of how much the function is used in the project. This measure is between 0 and 1

By using this action, you will have to register on the Ponicode SQUAR app and if you want to use Ponicode Unit Test Action, register on Ponicode platform. The terms & conditions of both apply when using this Github Action.

Highlights to our Terms & Conditions

• Ponicode does not store your code
• Ponicode use anonymous usage data to improve your experience

Have a bug or a feature request? Please open a new issue or reach out to us on the Ponicode Slack community https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/ using the channel #help or #feedback starting your message with “Ponicode SQUAR GitHub Action”

We would love to have your feedback! Tell us what you love and what you want us to improve about this action!

Our slack community is a place where people not only give feedback and get support but also an opportunity to share information and best practices about code quality. It’s also where you will get premium access to our new products and first hand information about our latest releases. Join us here: https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/

Want to find out more about our project? All our solutions are available on ponicode.com

You can generate a Ponicode SQUAR report for any of your GitHub repositories straight from our platform. Get started on Ponicode SQUAR Self Assessment

We also offer a unique VS Code Extension to accelerate your unit testing efforts.

Our AI-powered unit testing bulk generation is also available in the command line interface. Go discover our npm package today!

We also have a docstring generating GitHub Action for Python