StackGuardian/tirith

馃悰 cli.py: return non zero code when final evaluation returns false

Open

#89 opened on Nov 28, 2022

View on GitHubContributor guide
聽(0 comments)聽(0 reactions)聽(0 assignees)Python聽(41 forks)auto 404
buggood first issuehacktoberfest

Repository metrics

Stars
聽(168 stars)
PR merge metrics
聽(PR metrics pending)

Description

Describe the bug tirith always return zero code even when the final evaluator returns false (failed)

To Reproduce I was using these files: plan.json.txt apigateway_state_logging_enabled.tirith.json.txt

Steps to reproduce the behavior:

  1. Download and rename both of the files above, from .txt to .json
  2. Run tirith -policy-path apigateway_state_logging_enabled.tirith.json -input-path plan.json
  3. The final evaluation should be failed
  4. Check the return code by doing echo $?
  5. It will print 0 instead of 1

Expected behavior It should return non-zero code as it will make the caller of the program knows that tirith final evaluation has failed

Contributor guide

Research direction
Locate the exit code logic in cli.py. The program currently always returns 0. Modify it to return 1 when the final evaluation fails. Check the main function and the evaluate function.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80