Skip to content

Commit

Permalink
feat(audit.md): restore old audit.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
nprimo authored and kigiri committed Sep 5, 2023
1 parent 21c9a5d commit aaf24d6
Show file tree
Hide file tree
Showing 24 changed files with 1,795 additions and 0 deletions.
99 changes: 99 additions & 0 deletions subjects/0-shell/job-control/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
#### General

###### Was the project written in a compiled programming language?

#### Functional

##### Try to run the command `"tar -czf home.tar.gz . &"` then run the command `"jobs"`.

```
[1]+ Running tar -czf home.tar.gz . &
```

###### Can you confirm that the program displayed a list with the status of all jobs like in the example above?

##### Try to run the command `"jobs -l"`.

```
[1]+ 13612 Running tar -czf home.tar.gz . &
```

###### Can you confirm that the program added the process ID to the normal information given in the command `"jobs"` like in the example above?

##### Try to run the command `"jobs -p"`.

```
13612
```

###### Can you confirm that the program only displays the process ID like in the example above?

##### Try to run the command `"sleep 50000 &"` then run `"python &"` and press enter without any input in the last command.

```
[1] Running tar -czf home.tar.gz . &
[2]- Running sleep 50000 &
[3]+ Stopped python
```

###### Run the command `"jobs"`. Can you confirm that the program displays the list with the status of all jobs and that one of them is "Stopped" like the example above?

##### Try to run the command `"jobs -r"`.

```
[1] Running tar -czf home.tar.gz . &
[2]- Running sleep 50000 &
```

###### Can you confirm that the program only displays the list with running jobs like in the example above?

##### Try to run the command `"jobs -s"`.

```
[3]+ Stopped python
```

###### Can you confirm that the program only displays the list with stopped jobs like in the example above?

##### Try to run the command `"kill 7764"`(the process ID must be yours this is just an example).

```
[2]- Terminated sleep 50000
```

###### Can you confirm that the program killed and displayed the process with the given id like in the example above?

##### Try to run the command `"kill %1"`.

```
[1] Terminated tar -czf home.tar.gz
```

###### Can you confirm that the program killed and displayed the first process like in the example above?

##### Close the program and run it again. Try to run the commands `"tar -czf home.tar.gz . &"`, `"sleep 50000 &"` and then run `"fg"`.

```
sleep 50000
```

###### Can you confirm that the program brings the background job to the foreground like in the example above?

##### Try to run the command `"fg"` then stop the process with the `"Ctrl + Z"`.

```
sleep 50000
^Z
[2]+ Stopped sleep 50000
```

###### Can you confirm that the program brings the background job to the foreground and after you press `"Ctrl + Z"` the process stops like in the example above?

##### Try to run the command `"bg"`.

```
[2]+ sleep 50000 &
```

###### Run `"jobs"`. Can you confirm that the program started the process in the background like in the example above?
61 changes: 61 additions & 0 deletions subjects/0-shell/scripting/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
#### General

###### Was the project written in a compiled programming language?

###### Was the student shell script created?

#### Functional

##### Try to run the student script in your computer terminal and create the directory "Example".

```
Enter directory name
Example
Directory created
```

###### Can you confirm that the script is valid and the directory "Example" was created like in the example above?

##### Try to run the student script in the `0-shell` interpreter and create the directory "Example1".

```
Enter directory name
Example1
Directory created
```

###### Can you confirm that the script is valid and the directory "Example1" was created like in the example above?

##### Try to run the student script in the `0-shell` interpreter and create the directory with the same name as before "Example1".

```
Enter directory name
Example1
Directory exist
```

###### Can you confirm that the directory was not created and the script shows the message "Directory exist" because a directory with that name already exists like in the example above?

##### Try to run the command `"NAME="Alex""` followed by the command `"echo "Hello $NAME!""` in the `0-shell` interpreter.

```
Hello Alex!
```

###### Can you confirm that the script was validated and the project displayed the message as the example above?

##### Try to run the command `"for ((i = 0 ; i < 5 ; i++)); do echo $i; done"` followed by the command `"echo "Hello $NAME!""` in the `0-shell` interpreter.

```
0
1
2
3
4
```

###### Can you confirm that the script was validated and the project displayed the message as the example above?

##### Try to run the command `"echo "I'm in $(pwd)""` in the `0-shell` interpreter. Do the same in your computer terminal in the same folder.

###### Can you confirm that the script was validated and the project displayed the same message in both terminals?
70 changes: 70 additions & 0 deletions subjects/ascii-art-web/dockerize/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#### Functional

###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))

###### Does the project have a DockerFile?

##### Try running the [command](https://docs.docker.com/engine/reference/commandline/image_build/) `"docker image build [OPTIONS] PATH | URL | -"` to build the image using the project Dockerfile.
##### Example :
`"docker image build -f Dockerfile -t <name_of_the_image> ."`

```
student$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
<name of the image> latest 85a65d66ca39 7 seconds ago 795MB
```

###### Run the command `"docker images"` to see all images. Is the docker image built as above?

##### Try running the [command](https://docs.docker.com/engine/reference/commandline/container_run/) `"docker container run [OPTIONS] IMAGE [COMMAND] [ARG...]"` to start the container using the image just created. (example : `"docker container run -p <port_you_what_to_run> --detach --name <name_of_the_container> <name_of_the_image>"`)

```
student$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
cc8f5dcf760f ascii-art-web-docker "./server" 6 seconds ago Up 6 seconds 0.0.0.0:8080->8080/tcp ascii-art-web
```

###### Run the command `"docker ps -a"` to see all containers. Is the docker container running as above?

##### Try running the [command](https://docs.docker.com/engine/reference/commandline/exec/) `"docker exec [OPTIONS] CONTAINER COMMAND [ARG...]"`. (example : `"docker exec -it <container_name> /bin/bash"`) and do a `"ls -l"` to see the file system.

```
student$ docker exec -it postgres /bin/bash
I have no name!@51c2efe2d366:/$ ls -l
drwxr-xr-x 1 root root 4096 Dec 28 15:31 bin
-rwxr-xr-x 2 root root 4096 Sep 8 10:51 server.go
drwxr-xr-x 2 root root 4096 Sep 8 10:51 templates
I have no name!@51c2efe2d366:/$ exit
exit
student$
```

###### Does the DockerFile contain some [metadata](https://docs.docker.com/config/labels-custom-metadata/) applied to the docker object?

###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)

#### General

###### +Does the project present a script to build the images and containers? (using a script to simplify the build)

#### Basic

###### +Does the server run quickly and effectively? (Favoring recursive, no unnecessary data requests, etc)

###### +Does the code obey the [good practices](../../good-practices/README.md)?

###### +Is there a test file for this code?

###### +Are the tests checking each possible case?

###### +Are the instructions in the website clear?

###### +Does the project run using an API?

#### Social

###### +Did you learn anything from this project?

###### +Can it be open-sourced / be used for other sources?

###### +Would you recommend/nominate this program as an example for the rest of the school?
39 changes: 39 additions & 0 deletions subjects/ascii-art-web/export-file/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#### Functional

###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))

##### Try to export the file.

###### Does the exported file matches the output?

##### Try to open and change the exported file.

###### Are the exported files read and write for the user?

###### Does the project use the HTTP header [Content-Type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) to indicate the media type of the resource?

###### Does the project use the HTTP header [Content-Length](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length) to indicate the size of the entity-body, in bytes, sent to the recipient?

###### Does the project use the HTTP header [Content-Disposition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) to download the files?

###### Does the site has a clear button/link to download/export the file?

###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)

#### Basic

###### +Does the code obey the [good practices](../../good-practices/README.md)?

###### +Are the instructions in the website clear?

###### +Does the project run using an API?

###### +Can you export in multiple formats?

#### Social

###### +Did you learn anything from this project?

###### +Can it be open-sourced / be used for other sources?

###### +Would you recommend/nominate this program as an example for the rest of the school?
31 changes: 31 additions & 0 deletions subjects/ascii-art-web/stylize/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#### Functional

###### Do the colors used allow you to see the text properly (ex: yellow text on a white background is not usually very visible)?

###### Is the design [consistent](https://digitalcommunications.wp.st-andrews.ac.uk/2016/04/07/why-is-consistency-important-in-web-design/)? (examples: every page follows the same palette of colors, is all centered or is it everything aligned to the right, etc.)

###### Is the design [responsive](https://smallbiztrends.com/2013/05/what-is-responsive-web-design.html)? (when you change the width/ height of the page, is the site consistent?)

###### Is the design [interactive](https://en.m.wikipedia.org/wiki/Interactive_design)? (does it interact with the actions of the user?)

###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)

#### General

###### +Is it easy to use the web site?

###### +Does it have a background?

#### Basic

###### +Does the project runs quickly and effectively (Favoring of recursive, no unnecessary data requests, etc.)?

###### +Is the output of the program well structured? Is the output aligned, without any letter out of line?

###### +Does the code obey the [good practices](../../good-practices/README.md)?

#### Social

###### +Did you learn anything from this project?

###### +Would you recommend/nominate this program as an example for the rest of the school?
93 changes: 93 additions & 0 deletions subjects/ascii-art/color/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
#### Functional

###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))

##### Try passing as arguments `--color red "banana" `.

```
Usage: go run . [OPTION] [STRING]
EX: go run . --color=<color> <letters to be colored> "something"
```

###### Does it display the same result as above?

##### Try passing as arguments `--color=red "hello world"`.

###### Does it display the expected result?

##### Try passing as arguments `--color=green "1 + 1 = 2"`.

###### Does it display the expected result?

##### Try passing as arguments `--color=yellow "(%&) ??"`.

###### Does it display the expected result?

##### Try specifying a set of letters to be colored (the second until the last letter).

###### Does it display the expected result (the corresponding set of letters with that color)?

##### Try specifying letter to be colored (the second letter).

###### Does it display the expected result (the corresponding letter with that color)?

##### Try specifying a set of letters to be colored (just two letters).

###### Does it display the expected result (the corresponding set of letters with that color)?

##### Try passing as arguments `--color=orange GuYs "HeY GuYs"`, in order to color `GuYs`.

###### Does it display the expected result?

##### Try passing as arguments `--color=blue B 'RGB()'`, in order to color just the `B`.

###### Does it display the expected result?

##### Try passing as arguments a random string with lower and upper case letters, and a random color in the color flag ("--color=").

###### Does it display the expected result?

##### Try passing as arguments a random string with lower case letters, numbers and spaces, and a random color in the color flag ("--color=").

###### Does it display the expected result?

##### Try passing as arguments a random string with special characters, and a random color in the color flag ("--color="), specifying one letter to be colored.

###### Does it display the expected result?

##### Try passing as arguments a random string with lower case letters, upper case letters, spaces and numbers with a random color in the color flag ("--color="), specifying a set of letters to be colored.

###### Does it display the expected result?

###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)

#### General

###### +Is it easy/intuitive to specify letter(s) to be colored?

###### +Can you use more than one color in the same string?

#### Basic

###### +Does the project run quickly and effectively (favoring of recursive, no unnecessary data requests, etc.)?

###### +Is the output of the program well structured? Are the characters displayed correctly in line?

###### +Is there a test file for this code?

###### +Are the tests checking each possible case?

###### +Does the code obey the [good practices](../../good-practices/README.md)?

#### Social

###### +Did you learn anything from this project?

###### +Would you recommend/nominate this program as an example for the rest of the school?

#### Bonus

##### Try to use different `--color` flag notations like: `--color=red`, `--color=#ff0000`, `--color=rgb(255, 0, 0)` or `--color=hsl(0, 100%, 50%)`.

###### +Is it possible to use 2 or more color flag notations?
Loading

0 comments on commit aaf24d6

Please sign in to comment.