Refactoring

• Ruff Documentation
• List of Ruff Rules
• Refactoring.guru's section on refactoring
• Martin Fowler's catalog of refactorings

Welcome to the refactoring module! This challenge will serve as the first tutorial to how you will mainly be completing the challenges in this specific module. "Start" this challenge, and then you can interact with it by clicking on "Workspace" in the site's navigation bar or "VSCode Workspace" in the pop-up after the challenge has successfully started.

Start by running the checker Python executable by doing the following in the terminal:

$ cd /challenge
$ ./checker

The executable will then give you further instructions.

NOTE: For a Python file, you would usually run it by doing $ python3 [filename]. For this environment and platform, due to how permissions are handled so that you cannot simply read the flag, you MUST run checker by doing $ ./checker so that it can successfully read the flag and print it in the terminal. If you complete the tasks for the challenges but use $ python3 checker, you will get an error in the terminal (the file won't actually be executed).

In addition, you will get an error if you try to read the checker file / open it up in VSCode. This is intentional. Again, you MUST run checker as specified above.

In this last tutorial for this module on refactoring, you are asked by your manager to make sure the code is not using any constants in any logic that involves comparisons.

This time, there are also test cases to make sure SimpleSIEM operates as usual after your refactoring! That way, you can't just delete the function and call it a day. Usage test cases will continue to be something else you have to consider moving forward. You can check the list of test cases in checker under the TestSimpleSIEM class.

Start by running the checker Python executable in /challenge. Make sure to run it with the following:

$ ./checker

The executable will give you further instructions.

In this last tutorial for this module on refactoring, you are asked by your manager to make sure the code is not using any constants in any logic that involves comparisons.

This time, there are also test cases to make sure SimpleSIEM operates as usual after your refactoring! That way, you can't just delete the function and call it a day. Usage test cases will continue to be something else you have to consider moving forward. You can check the list of test cases in checker under the TestSimpleSIEM class.

Start by running the checker Python executable in /challenge. Make sure to run it with the following:

$ ./checker

The executable will give you further instructions.