Feature/test examples

[MaGering]

Fix Issue #228

With this PR tests are added which check if the examples in pvcompare run.

Running with exit code == 0 leads to:

os.system("python example_to_be_tested.py") == 0

The following steps were realized, as well (required):

• Update the CHANGELOG.md
• Check if full simulation tests pass locally (EXECUTE_TESTS_ON=master pytest)

Also the following steps were realized (if applies):

• Use in-line comments to explain your code
• Write docstrings to your code
• For new functionalities: Explain in readthedocs
• Write test(s) for your new patch of code

Please mark above checkboxes as following:

• Open
• Done

In case of an error due to linting, run black . --exclude docs/ and push your changes.
Note that in case you do not fix a whole issue you should start your PR with Address #xyz.

_{For more information on how to contribute check the CONTRIBUTING.md.}

[SabineHaas]

Thank you @MaGering for adding these tests!

As you have said yourself there are comments that need adaption.

Where do you actually run the test? Does if os.system("python " + self.elec_sector_path) == 0: run the python file?

[SabineHaas]

This part (deleting files) could be a teardown method or teardown class to avoid doubling.

[MaGering]

Done with commit 68b087b.

[MaGering]

Where do you actually run the test? Does if os.system("python " + self.elec_sector_path) == 0: run the python file?

Yes exactly, it executes the script and returns the exit code in 16 bits code. I explained this (with recent commit 3cee624) in a comment in the lines above if os.system("python " + self.elec_sector_path) == 0: .
But basically exit code 0 leads to 0 and exit code 1 leads to 256.

[MaGering]

@SabineHaas do you know why the Read the Docs build fails? :-/

[SabineHaas]

@SabineHaas do you know why the Read the Docs build fails? :-/

Seems like there's a problem with the installation of mock.. However, for #275 it works..
You could try to merge #275 to dev and merge changes into this PR.
If it still fails then we need to check further..

[SabineHaas]

Could you add an assertion statement behind the assertion e.g.
`, f"The example 'xy' exited with exit code {exit_code}." ?

Then everything looks good from my point of view.

[MaGering]

Could you add an assertion statement behind the assertion e.g.
`, f"The example 'xy' exited with exit code {exit_code}." ?

Good point! Done with commit 5952083.