Skip to content

Commit b6159a1

Browse files
committed
fix: Documentation for developers, unit tests
1 parent 8c7a5e9 commit b6159a1

File tree

3 files changed

+9
-18
lines changed

3 files changed

+9
-18
lines changed

docs/source/contents/developer.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,23 @@ a link to do a global logout.
2121
Unit tests
2222
==========
2323

24-
You can also run the unit tests as follows::
24+
Djangosaml2 have a legacy way to do tests, using an example project in `tests` directory.
25+
This means that to run tests you have to clone the repository, then install djangosaml2, then run tests using the example project.
26+
27+
example::
2528

2629
pip install -r requirements-dev.txt
2730
# or
2831
pip install djangosaml2[test]
29-
python3 tests/manage.py migrate
30-
31-
then::
3232

33-
python tests/run_tests.py
3433

35-
or::
36-
37-
cd tests/
34+
then::
35+
cd tests
36+
./manage.py migrate
3837
./manage.py test djangosaml2
3938

4039

41-
If you have `tox`_ installed you can simply call tox inside the root directory
40+
If you have `tox`_ installed you can simply call `tox` inside the root directory
4241
and it will run the tests in multiple versions of Python.
4342

4443
.. _`tox`: http://pypi.python.org/pypi/tox

docs/source/contents/setup.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,6 @@ installed apps::
4848
'djangosaml2', # new application
4949
)
5050

51-
.. Note::
52-
53-
When you finish the configuration you can run the djangosaml2 test suite as
54-
you run any other Django application test suite. Just type ``python manage.py
55-
test djangosaml2``.
56-
57-
Python users need to ``pip install djangosaml2[test]`` in order to run the
58-
tests.
5951

6052
SameSite cookie
6153
===============

tests/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
DATABASES = {
7676
'default': {
7777
'ENGINE': 'django.db.backends.sqlite3',
78-
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
78+
'NAME': os.path.join(BASE_DIR, 'tests/db.sqlite3'),
7979
}
8080
}
8181

0 commit comments

Comments
 (0)