README.md

42FileChecker

42FileChecker is a tiny bash script developped at 42 school for testing and checking the files according to the rules of the subjects.

The script is designed as a reminder:

• author file terminated by a Line Feed
• count and files name
• code's standard
• required and forbidden functions
• macro definitionsl
• static variables & functions declarations
• makefile rules

Extra tests may also be performed:

• memory leaks detection
• speed test comparison
• Unit Tests

Complete unit tests are handled through external frameworks whose sources are automatically downloaded, configured and updated in background when you run the script:

• moulitest, developed by @yyang42 and other contributors
• libft-unit-test, developped by @alelievr (for libft only)

install & launch

git clone https://github.com/jgigault/42FileChecker ~/42FileChecker
cd ~/42FileChecker && sh ./42FileChecker.sh

You may also want to set an alias to run it from everywhere, even in your project path. Add this line of code at the end of your shell initialization file (e.g.: ~/.zshrc):

alias 42FileChecker='sh ~/42FileChecker/42FileChecker.sh'

options

--no-update         // Do not check for updates at launch
--no-color          // Do not display color tags
--no-timeout        // Disable time-out
--no-norminette     // Disable code's standard check
--no-leaks          // Disable memory leaks detection
--no-speedtest      // Disable speed test comparison
--no-moulitest      // Disable moulitest
--no-libftunittest  // Disable libft-unit-test

Add your options as arguments before launch:

sh ./42FileChecker.sh --no-update --no-timeout

supported projects

	libft	libftasm	gnl	ft_ls	ft_printf	fdf
auteur	Yes	Yes	Yes	Yes	Yes	Yes
norminette	Yes		Yes	Yes	Yes	Yes
makefile	Yes	Yes	Yes	Yes	Yes	Yes
forbidden functions	Yes	Yes	Yes	Yes	Yes	Yes
extra functions	Yes	Yes
leaks			Yes	Yes	Yes
speed test				Yes	Yes
tests with compilation		Yes	Yes		Yes
moulitest	Yes		Yes	Yes	Yes
libft-unit-test	Yes

update

At launch, 42FileChecker invites you to get the latest version of the sources and dependencies when available. You may just simply accept or skip the message.

contribute

If you want to fix or to improve the 42FileChecker, follow the guide lines Contributing to 42FileChecker, or if you want your own unit testing framework to be integrated in the 42FileChecker, just let me know at jgigault@student.42.fr

bash tips and tricks

42FileChecker has an online wiki on github that gives you tips and lessons in Bash programming:

• What is Bash
• What is a bash script
• What is 42FileChecker
• Contributing to 42FileChecker
  • Tip: Rebasing a Pull Request
• Bash syntax: Variables
  • 1. Declaration
  • 2. Substitution
  • 3. Positional and special parameters
• Bash syntax: Conditions
  • 1. Conditional expressions
  • 2. If-then-else
  • 3. Case-in
• Bash syntax: Functions
  • 1. Syntax of a function
  • 2. Local and global variables
  • 3. Arguments of a function
  • 4. Passing an array as argument
• Bash builtin commands
• Bash tools: Awk
  • 1. How to use AWK
  • 2. How works AWK
  • 3. AWK built-in variables
  • 4. Simple AWK examples
• Bash tools: Cat
• Bash tools: Grep
• Bash tools: Sed
• Bash sample code: auto-update (git tool)
• Bash sample code: Create an interactive menu
  • Sample code
  • Tip: Convert ASCII number into numeric value
  • Tip: Check if an index is valid
  • Tip: Evaluate a string as a command line
• Bash sample code: Animated spinner with a time out
  • Sample code
  • Tip: Arithmetic operation with floating numbers
  • Tip: Check if a process ID has terminated
  • Tip: Move the first character to the end of a string
• Bash sample code: static var test
• Bash sample code: Check the basic rules of a makefile
  • Sample code
  • Tip: Check if a file or a directory exists
  • Tip: Read a whole file into a variable
  • Tip: Find a string in a file using awk
  • Tip: Get inode of a file
• Bash sample code: forbidden functions test
• Bash sample code: leaks test
• Bash sample code: Create a speed test
  • Sample code
  • Tip: Redirect outputs of a command line
  • Tip: Count the number of lines of a file
  • Tip: Execute a command and save the result in a variable