Conducted: 29.8.2020

What I did

• Set up the environment and downloaded the project
• Ran the program locally
• Ran the project's unit tests
• Read through the documentation
• Downloaded the project source code and went through it

General Feedback

• The project's purpose is clear and well communicated
• It's a shame that I could not get it to work. It would have been fun to try out.
• The focus of improvement in my opinion should be on the documentation and making it easier to use
• A suggestion would be to include a UI where the user can feed the files directly

Issues

• I was unable to get the program to work - it would freeze after running it.
• I took steps to reproduce the error by altering inputs in both the password and training files, but this was to no avail.
• Both tests failed. I got: ModuleNotFoundError: No module named 'bforce' and ModuleNotFoundError: No module named 'markov'. These modules seem to be imported in the file, but I don't know enough about python unit tests to tell what's up
• If there is a specific way to run the test, or some commands that should be run, then these should be well documented

Code Quality

• The code is somewhat easy to follow due to the limited scope of the project and the fact that Python is generally very readable.
• Variables are descriptively named
• Test names could more descriptive, e.g. what does 'test_markov_build_equals' mean?
• The tests could be more comprehensive in what they test , e.g. how the program/algo responds to unexpected input.
• The structure is good - modules are in their folders
• Exceptions handling could be improved - the program simply freezes and the user is left guessing why. From the looks of it, the program should, for instance, inform the user when the training file is empty. I left mine empty and it did not exception out.
• Since the program run time increases exponentially with larger inputs, the user should be warned/informed of this during runtime

Documentation

External

• Most of the required documentation was included in the project - needs more work though
• There should probably be links to the specific documentation files in the README, especially the user guide
• The user instructions/guide could be clearer - it would be a good idea to communicate all the steps needed to use your program, e.g. how to run the entry file (run.py).
• How a user inputs data into the program could also be clearer - what are the files called? What form should the input data be in? This information can be found from the config files, but it'd be better for it to be more obvious.

Repository

• There are helpful comments that accompany most of the methods
• There could definitely be more comments that are focused on why things are being done the way they are. An example is the markov method - difficult to follow what's going on

Ladattu klo 18.29 19.8.2020

• Tiedoston run.py funktiossa run yhtä avattua tiedostoa ei suljeta, jos prosessointi keskeytyy poikkeuksen takia. Tiedoston avaamisessa voisi käyttää with-rakennetta kuten samassa funktiossa on tehty toista tiedostoa avattaessa.
• Jos syötetiedostossa on salasana, jossa on merkki, jota ei ole listattu mahdollisiin merkkeihin konfiguraatiotiedostossa, ohjelma jäätyy ja lopulta kaatuu. Se heittää poikkeuksen Error: cannot unpack non-iterable NoneType object. Koodin tarkastelun perusteella Luokan bruteForce metodi guess ei tällöin palauta mitään arvoa return lauseella, koska toistorakenteiden perään ei ole kirjoitettu return lausetta. Jonkinlaisen erillisen virhearvon palauttaminen tai poikkeuksen heittäminen ja käsitteleminen voisivat olla mahdollisia ratkaisuja.
• Koodissa voisi olla enemmän dokumentaatiota luokkien ja metodien toiminnallisuudesta ja tarkoituksesta. Erityisesti koodin määrän kasvaessa se helpottaisi koodin ymmärtämistä.
• Testien suorittaminen ei onnistu, vaan antaa seuraavan virheen:

  Traceback (most recent call last):
  File "test_brute_force.py", line 3, in <module>
    from bforce.brute_force import bruteForce
  ModuleNotFoundError: No module named 'bforce'
  

  En tosin ole ihan varma, osasinko suorittaa testejä oikealla tavalla. Tarvittavat komennot voisi listata README-tiedostossa.