add tests

CHANGELOG.rst

@@ -0,0 +1,19 @@
+Release history
+=====================================
+0.6
+-------------------------------------
+2014-10-12
+
+- Django 1.7 support.
+
+0.5
+-------------------------------------
+2013-09-09
+
+- Python 3 support.
+
+0.1
+-------------------------------------
+2013-02-04
+
+- Initial.

CREDITS.rst

@@ -11,4 +11,5 @@ Bug reporters
 ~~~~~~~~~~~~~~~~~~~~~~
 The following people contributed to the project by reportings bugs.
 
-- Raitis Stengrevics: Reported an issue of a hard-coded HTTP protocol in ``qartez.RelAlternateHreflangSitemap``.
+- Raitis Stengrevics: Reported an issue of a hard-coded HTTP protocol in
+  ``qartez.RelAlternateHreflangSitemap``.

builddocs.sh

@@ -1,2 +1,4 @@
+./uninstall.sh
 ./install.sh
-sphinx-build -n -a -b html docs builddocs
+sphinx-build -n -a -b html docs builddocs
+cd builddocs && zip -r ../builddocs.zip . -x ".*" && cd ..

example/example/foo/management/commands/foo_create_test_data.py

@@ -1,8 +1,10 @@
 import random
 
-from six import print_, PY2, PY3
+from six import print_, PY3
 from six.moves import range
 
+PY2 = not PY3
+
 if PY2:
     from string import translate, maketrans, punctuation
 else:

example/example/settings.py

@@ -116,7 +116,7 @@
     # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
     # Always use forward slashes, even on Windows.
     # Don't forget to use absolute paths, not relative paths.
-    PROJECT_DIR('templates')
+    PROJECT_DIR('templates'),
 )
 
 #FIXTURE_DIRS = (

example/freeze.txt

@@ -0,0 +1,7 @@
+Django==1.5.2
+Pillow==2.1.0
+argparse==1.2.1
+django-qartez==0.5
+radar==0.2
+six==1.4.1
+wsgiref==0.1.2

example/requirements.txt

@@ -1,9 +1,7 @@
-Django==1.5.1
-Pillow==2.0.0
-argparse==1.2.1
-django-debug-toolbar==0.9.4
-django-qartez==0.3
-ipdb==0.7
-ipython==0.13.2
-qartez==0.3
-wsgiref==0.1.2
+Django>=1.5,<1.8
+Pillow
+argparse
+django-debug-toolbar
+ipdb
+ipython
+wsgiref

setup.py

@@ -9,7 +9,7 @@
 template_dir = "src/qartez/templates/qartez"
 templates = [os.path.join(template_dir, f) for f in os.listdir(template_dir)]
 
-version = '0.5'
+version = '0.6'
 
 setup(
     name = 'django-qartez',

src/qartez/__init__.py

@@ -1,12 +1,12 @@
 __title__ = 'qartez.__init__'
-__version__ = '0.5'
-__build__ = 0x000005
+__version__ = '0.6'
+__build__ = 0x000006
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('ImagesSitemap', 'StaticSitemap', 'RelAlternateHreflangSitemap',)
 
 import datetime
 
-from six import PY2, PY3
+from six import PY3
 
 from django.contrib.sitemaps import Sitemap, GenericSitemap
 from django.core.urlresolvers import reverse_lazy
@@ -17,6 +17,7 @@
 from qartez.constants import REL_ALTERNATE_HREFLANG_SITEMAP_TEMPLATE
 from qartez.settings import PREPEND_LOC_URL_WITH_SITE_URL, PREPEND_IMAGE_LOC_URL_WITH_SITE_URL
 
+PY2 = not PY3
 
 class ImagesSitemap(GenericSitemap):
     """

src/qartez/conf.py

@@ -1,6 +1,4 @@
 __title__ = 'qartez'
-__version__ = '0.5'
-__build__ = 0x000005
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('get_setting',)
 

src/qartez/constants.py

@@ -1,6 +1,4 @@
 __title__ = 'qartez'
-__version__ = '0.5'
-__build__ = 0x000005
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('REL_ALTERNATE_HREFLANG_SITEMAP_TEMPLATE',)
 

src/qartez/defaults.py

@@ -1,6 +1,4 @@
 __title__ = 'qartez'
-__version__ = '0.5'
-__build__ = 0x000005
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('PREPEND_LOC_URL_WITH_SITE_URL', 'PREPEND_IMAGE_LOC_URL_WITH_SITE_URL', 'CHANGEFREQ', 'DEBUG')
 

src/qartez/settings.py

@@ -10,8 +10,6 @@
 ``CHANGEFREQ``: Valid changefreq values according to the specs http://www.sitemaps.org/protocol.html
 """
 __title__ = 'qartez'
-__version__ = '0.5'
-__build__ = 0x000005
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('PREPEND_LOC_URL_WITH_SITE_URL', 'PREPEND_IMAGE_LOC_URL_WITH_SITE_URL', 'CHANGEFREQ', 'DEBUG')
 

src/qartez/tests/__init__.py

@@ -0,0 +1,11 @@
+__title__ = 'qartez.tests'
+__author__ = 'Artur Barseghyan'
+__copyright__ = 'Copyright (c) 2013-2014 Artur Barseghyan'
+__license__ = 'GPL 2.0/LGPL 2.1'
+
+import unittest
+
+from qartez.tests.test_sitemaps import *
+
+if __name__ == '__main__':
+    unittest.main()

src/qartez/tests/base.py

@@ -0,0 +1,30 @@
+from __future__ import print_function
+
+__title__ = 'qartez.tests.base'
+__author__ = 'Artur Barseghyan'
+__copyright__ = 'Copyright (c) 2013-2014 Artur Barseghyan'
+__license__ = 'GPL 2.0/LGPL 2.1'
+
+PRINT_INFO = True
+
+def print_info(func):
+    """
+    Prints some useful info.
+    """
+    if not PRINT_INFO:
+        return func
+
+    def inner(self, *args, **kwargs):
+        result = func(self, *args, **kwargs)
+
+        print('\n\n%s' % func.__name__)
+        print('============================')
+        if func.__doc__:
+            print('""" %s """' % func.__doc__.strip())
+        print('----------------------------')
+        if result is not None:
+            print(result)
+        print('\n++++++++++++++++++++++++++++')
+
+        return result
+    return inner

src/qartez/tests/test_sitemaps.py

@@ -0,0 +1,98 @@
+__title__ = 'qartez.tests.test_sitemaps'
+__author__ = 'Artur Barseghyan'
+__copyright__ = 'Copyright (c) 2013-2014 Artur Barseghyan'
+__license__ = 'GPL 2.0/LGPL 2.1'
+
+import unittest
+import os
+
+# Skipping from non-Django tests.
+if os.environ.get("DJANGO_SETTINGS_MODULE", None):
+    from django.test import Client
+
+    from qartez.tests.base import print_info
+
+    class QartezTest(unittest.TestCase):
+        """
+        Testing sitemaps.
+        """
+        def setUp(self):
+            # Testing the URLs
+            self.urls = {
+                'sitemap of sitemaps': '/sitemap.xml',
+                'normal sitemap': '/sitemap-foo-items.xml',
+                'images sitemap': '/sitemap-foo-images.xml',
+                'static sitemap': '/sitemap-foo-static.xml',
+                'alternative hreflang sitemap': '/sitemap-foo-items-alternate-hreflang.xml',
+            }
+
+        @print_info
+        def test_all_sitemaps(self):
+            """
+            Test the all sitemaps.
+            """
+            flow = []
+            ## Testing view with signed URL
+            client = Client()
+            for description, url in self.urls.items():
+                response = client.get(url, {})
+                self.assertTrue(response.status_code in (200, 201, 202))
+                flow.append(
+                    'Response status code for {0} is {1}'.format(
+                        description, response.status_code
+                        )
+                    )
+
+            return flow
+
+        @print_info
+        def test_01_alternative_hreflang_sitemap(self):
+            """
+            Test alternate hreflang sitemap.
+            """
+            flow = []
+            c = Client()
+            response = c.get('/sitemap-foo-items-alternate-hreflang.xml', {})
+            self.assertTrue('hreflang="en-us"' in response.content)
+            self.assertTrue('rel="alternate"' in response.content)
+            self.assertTrue('hreflang="en-us"' in response.content)
+
+        @print_info
+        def test_02_static_sitemap(self):
+            """
+            Test static sitemap.
+            """
+            flow = []
+            c = Client()
+            response = c.get('/sitemap-foo-static.xml', {})
+            self.assertTrue('http://example.com/foo/contact/' in response.content)
+
+        @print_info
+        def test_03_images_sitemap(self):
+            """
+            Test images sitemap.
+            """
+            flow = []
+            c = Client()
+            response = c.get('/sitemap-foo-images.xml', {})
+            self.assertTrue('http://www.google.com/schemas/sitemap-image/1.1' in response.content)
+            self.assertTrue('<image:title>' in response.content)
+            self.assertTrue('<image:loc>' in response.content)
+            self.assertTrue('<image:image>' in response.content)
+
+        @print_info
+        def test_04_sitemap_of_sitemaps(self):
+            """
+            Test sitemap of sitemaps.
+            """
+            flow = []
+            c = Client()
+            response = c.get('/sitemap.xml', {})
+            self.assertTrue('<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' in response.content)
+            self.assertTrue('https://example.com/sitemap-foo-items-alternate-hreflang.xml' in response.content)
+            self.assertTrue('http://example.com/sitemap-foo-items.xml' in response.content)
+
+
+if __name__ == "__main__":
+    # Tests
+    unittest.main()

src/qartez/views.py

@@ -1,6 +1,4 @@
 __title__ = 'qartez.views'
-__version__ = '0.5'
-__build__ = 0x000005
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __all__ = ('render_images_sitemap',)
 

test.sh

@@ -0,0 +1,4 @@
+reset
+./uninstall.sh
+./install.sh
+python example/example/manage.py test qartez --traceback -v 3

uninstall.sh

@@ -2,4 +2,5 @@ pip uninstall django-qartez -y
 rm build -rf
 rm dist -rf
 rm example/static -rf
-rm src/django_qartez.egg-info -rf
+rm src/django_qartez.egg-info -rf
+rm builddocs.zip