#131 Updating instructions for Windows development environment setup.
Merged 2 months ago by jflory7. Opened 2 months ago by phoenixabhishek.

Added instructions for tests
PhoeniXAbhisheK • 2 months ago  

@@ -18,7 +18,7 @@

  Setting up the development environment

  ========================================

  

- #. Fork the `current repository <https://pagure.io/fedora-commops/fedora-happiness-packets>`_ to your profile .

+ #. Fork the `current repository <https://pagure.io/fedora-commops/fedora-happiness-packets>`_ to your profile.

  #. Clone this forked repository to your system using Git with the following command::

  

      git clone "https://pagure.io/forks/<user_name>/fedora-commops/fedora-happiness-packets.git"

@@ -74,11 +74,12 @@

      docker-compose exec web sh

  

  Then the terminal will show a ``#`` symbol.

- Simply type in ``t`` to initiate the test suite.

+ Simply type in ``./t`` (or ``t``) to initiate the test suite.

  

- (The test suite are run by running the ``t`` script, which runs the tests with the appropriate testing settings and provides a coverage report.)

+ (The test suite are run by running the ``./t`` script, which runs the tests with the appropriate testing settings and provides a coverage report.)

  

  Integration tests are run via the following command::

  

-     manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting

+     docker-compose exec web ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting

  

+ If a ``file not found`` error occurs, try removing the ``./`` from the command and try again.

1.What is a summary of your change?

While setting up the environment afresh, it was observed that the test commands, were giving an error of file not found when used without preceding ./ This was not the case earlier, so added both the options to the setup document to make user aware of both the approaches.

After considering this comment on #130 , it would be better to give the user the complete command of
docker-compose exec web ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting instead of just
./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting to make it more clear to users that it needs to be run via exec in the docker container.

2.Why is this change helpful?

This change will avoid users getting stuck on errors, and will also be useful to users who are new to the docker environment.

3.Any specific details to consider?

This can be added to the other setup documents as well.

4.What do you think is the outcome of this change?

A user will be able to setup the environment better, and hopefully without having to look for what steps were missed that resulted in an error.

1 new commit added

  • newline added
2 months ago

rebased onto e46c5b2

2 months ago

@phoenixabhishek Nice improvement. :thumbsup: This makes sense. Merging it now! :clapper:

Metadata Update from @jflory7:
- Pull-request tagged with: improvement, type - docs, type - summer coding
- Request assigned

2 months ago

Pull-Request has been merged by jflory7

2 months ago