Skip to content

chore: improve logger config and error codes #174

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

Merged
merged 2 commits into from
Apr 21, 2023
Merged

chore: improve logger config and error codes #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04416a8
chore: improve logger config and error codes
behnazh-w Apr 20, 2023
27cbd73
chore: adjust Operating System classifier
behnazh-w Apr 21, 2023
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
4 changes: 3 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ classifiers = [
"Intended Audience :: Developers",
"License :: OSI Approved :: Universal Permissive License (UPL)",
"Natural Language :: English",
"Operating System :: OS Independent",
"Operating System :: POSIX",
"Operating System :: POSIX :: Linux",
"Operating System :: MacOS",
"Programming Language :: Python",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3 :: Only",
Expand Down
71 changes: 42 additions & 29 deletions src/macaron/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def analyze_slsa_levels_single(analyzer_single_args: argparse.Namespace) -> None
)
if not html_reporter.template:
logger.error("Exiting because the custom template cannot be found.")
sys.exit(1)
sys.exit(os.EX_NOINPUT)

analyzer.reporters.append(html_reporter)
else:
Expand All @@ -65,7 +65,7 @@ def analyze_slsa_levels_single(analyzer_single_args: argparse.Namespace) -> None
validate_result: ValidationResult = TARGET_CONFIG_SCHEMA.validate(run_config, "config_generated", strict=False)
if not validate_result.isValid():
logger.critical("The generated config dict is invalid.")
sys.exit(1)
sys.exit(os.EX_DATAERR)

elif analyzer_single_args.config_path:
# Get user config from yaml file
Expand All @@ -82,11 +82,11 @@ def verify_prov(verify_args: argparse.Namespace) -> Never:

if not policy_files:
logger.error("The policy is not provided to complete this action.")
sys.exit(1)
sys.exit(os.EX_NOINPUT)

if len(policy_files) > 1:
logger.error("Exactly one policy must be provided to complete this action.")
sys.exit(1)
sys.exit(os.EX_USAGE)

policy_file = policy_files[0]
try:
Expand All @@ -95,31 +95,32 @@ def verify_prov(verify_args: argparse.Namespace) -> Never:

if not policy:
logger.error("Could not load policy at %s.", policy_file)
sys.exit(1)
sys.exit(os.EX_NOINPUT)

logger.info("Validating the provenance at %s against %s.", prov_file, policy)

if not policy.validate(prov_content):
logger.error("The validation for provenance at %s is unsuccessful.", prov_file)
sys.exit(1)
logger.error("The validation for provenance at %s was unsuccessful.", prov_file)
sys.exit(os.EX_NOINPUT)

logger.info("The validation for provenance at %s is successful.", prov_file)
sys.exit(0)
logger.info("The validation for provenance at %s was successful.", prov_file)
sys.exit(os.EX_OK)
except (SLSAProvenanceError, PolicyRuntimeError) as error:
logger.error(error)
sys.exit(1)
sys.exit(os.EX_DATAERR)


def perform_action(action_args: argparse.Namespace) -> None:
"""Perform the indicated action of Macaron."""
if action_args.action == "dump_defaults":
# Create the defaults.ini file in the output dir and exit.
create_defaults(action_args.output_dir, os.getcwd())
sys.exit(0)
sys.exit(os.EX_OK)

# Check that the GitHub token is enabled.
if not action_args.personal_access_token:
raise argparse.ArgumentError(None, "GitHub access token not set.")
logger.error("GitHub access token not set.")
sys.exit(os.EX_USAGE)

match action_args.action:
case "analyze":
Expand All @@ -128,7 +129,7 @@ def perform_action(action_args: argparse.Namespace) -> None:
verify_prov(action_args)
case _:
logger.error("Macaron does not support command option %s.", action_args.action)
sys.exit(1)
sys.exit(os.EX_USAGE)


def main() -> None:
Expand Down Expand Up @@ -256,7 +257,7 @@ def main() -> None:

if not args.action:
main_parser.print_help()
sys.exit(1)
sys.exit(os.EX_USAGE)

if args.verbose:
log_level = logging.DEBUG
Expand All @@ -265,27 +266,39 @@ def main() -> None:
log_level = logging.INFO
log_format = "%(asctime)s [%(levelname)s] %(message)s"

# Set logging config.
logging.basicConfig(format=log_format, handlers=[logging.StreamHandler()], force=True, level=log_level)
# Set global logging config. We need the stream handler for the initial
# output directory checking log messages.
st_handler = logging.StreamHandler(sys.stdout)
logging.basicConfig(format=log_format, handlers=[st_handler], force=True, level=log_level)

# Set the output directory
if args.output_dir:
if os.path.isfile(args.output_dir):
logger.error("The output directory already exists. Exiting ...")
sys.exit(1)
# Set the output directory.
if not args.output_dir:
logger.error("The output path cannot be empty. Exiting ...")
sys.exit(os.EX_USAGE)

if os.path.isdir(args.output_dir):
logger.info("Setting the output directory to %s", args.output_dir)
else:
logger.info("No directory at %s. Creating one ...", args.output_dir)
os.makedirs(args.output_dir)
if os.path.isfile(args.output_dir):
logger.error("The output directory already exists. Exiting ...")
sys.exit(os.EX_USAGE)

# Set logging debug level. We only need to set for the root logger.
if os.path.isdir(args.output_dir):
logger.info("Setting the output directory to %s", args.output_dir)
else:
logger.info("No directory at %s. Creating one ...", args.output_dir)
os.makedirs(args.output_dir)

# Add file handler to the root logger. Remove stream handler from the
# root logger to prevent dependencies printing logs to stdout.
Copy link
Contributor

Choose a reason for hiding this comment

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

By dependencies, do you mean the Python third-party dependencies that we have for Macaron?

Copy link
Member Author

Choose a reason for hiding this comment

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

By dependencies, do you mean the Python third-party dependencies that we have for Macaron?

Yes, for example SQLAlchemy.

debug_log_path = os.path.join(args.output_dir, "debug.log")
log_file_handler = logging.FileHandler(debug_log_path, "w")
log_file_handler.setFormatter(logging.Formatter(log_format))
logging.getLogger().removeHandler(st_handler)
logging.getLogger().addHandler(log_file_handler)
logger.info("The log file of Macaron will be stored in debug.log")

# Add StreamHandler to the Macaron logger only.
mcn_logger = logging.getLogger("macaron")
mcn_logger.addHandler(st_handler)

logger.info("The logs will be stored in debug.log")

# Set Macaron's global configuration.
global_config.load(
Expand All @@ -302,7 +315,7 @@ def main() -> None:
# Load the default values from defaults.ini files.
if not load_defaults(args.defaults_path):
logger.error("Exiting because the defaults configuration could not be loaded.")
sys.exit(1)
sys.exit(os.EX_NOINPUT)

perform_action(args)

Expand Down