Merge pull request #407 from cloudant/test-attributes

Added test attributes

Author: ricellis

.travis.yml

@@ -30,7 +30,7 @@ before_script:
 # command to run tests
 script:
     - pylint ./src/cloudant
-    - nosetests -w ./tests/unit
+    - nosetests -A 'not db or ((db is "couch" or "couch" in db) and (not couchapi or couchapi <='${COUCHDB_VERSION:0:1}'))' -w ./tests/unit
 
 notifications:
   email: false

CONTRIBUTING.md

@@ -82,3 +82,12 @@ test behaviour:
       This user is deleted at the end of the test run, but beware it'll
       break other applications using the CouchDB instance that rely on
       admin party mode being in effect while the tests are running.
+
+### Test attributes
+
+Database tests also have node attributes. Currently there are these attributes:
+`db` - `cloudant` and/or `couch`
+`couchapi` - Apache CouchDB major version number (i.e. API level) e.g. `2`
+
+Example to run database tests that require CouchDB version 1 API and no Cloudant features:
+`nosetests -A 'db and ((db is "couch" or "couch" in db) and (not couchapi or couchapi <=1))' -w ./tests/unit`

Jenkinsfile

@@ -37,7 +37,7 @@ def setupPythonAndTest(pythonVersion, testSuite) {
             pip install -r requirements.txt
             pip install -r test-requirements.txt
             pylint ./src/cloudant
-            nosetests -w ./tests/unit --with-xunit
+            nosetests -A 'not db or (db is "cloudant" or "cloudant" in db)' -w ./tests/unit --with-xunit
           """
         } finally {
           // Load the test results

tests/unit/auth_renewal_tests.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2016, 2017 IBM. All rights reserved.
+# Copyright (C) 2016, 2018 IBM Corp. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,15 +18,18 @@
 See configuration options for environment variables in unit_t_db_base
 module docstring.
 """
-import unittest
 import os
-import requests
 import time
+import unittest
 
+import requests
 from cloudant._client_session import CookieSession
+from nose.plugins.attrib import attr
 
 from .unit_t_db_base import skip_if_not_cookie_auth, UnitTestDbBase
 
+
+@attr(db=['cloudant','couch'])
 @unittest.skipIf(os.environ.get('ADMIN_PARTY') == 'true', 'Skipping - Admin Party mode')
 class AuthRenewalTests(UnitTestDbBase):
     """

tests/unit/changes_tests.py

@@ -16,20 +16,23 @@
 Unit tests for _changes feed
 """
 
-import unittest
-from requests import Session
 import json
 import os
+import unittest
 
-from cloudant.feed import Feed
-from cloudant.document import Document
+from cloudant._2to3 import unicode_
 from cloudant.design_document import DesignDocument
+from cloudant.document import Document
 from cloudant.error import CloudantArgumentError
-from cloudant._2to3 import unicode_
+from cloudant.feed import Feed
+from nose.plugins.attrib import attr
+from requests import Session
 
 from .unit_t_db_base import UnitTestDbBase
 from .. import BYTETYPE
 
+
+@attr(db=['cloudant','couch'])
 class ChangesTests(UnitTestDbBase):
     """
     _changes feed unit tests
@@ -41,7 +44,6 @@ def setUp(self):
         """
         super(ChangesTests, self).setUp()
         self.db_set_up()
-        self.cloudant_test = os.environ.get('RUN_CLOUDANT_TESTS') is not None
 
     def tearDown(self):
         """
@@ -448,8 +450,6 @@ def test_get_feed_using_conflicts_false(self):
         self.assertSetEqual(set([x['id'] for x in changes]), expected)
         self.assertTrue(str(feed.last_seq).startswith('3'))
 
-    @unittest.skipIf(os.environ.get('RUN_CLOUDANT_TESTS') is not None,
-        'Skipping since _doc_ids filter is not supported on all Cloudant clusters')
     def test_get_feed_using_doc_ids(self):
         """
         Test getting content back for a feed using doc_ids

tests/unit/client_tests.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2015, 2017 IBM Corp. All rights reserved.
+# Copyright (C) 2015, 2018 IBM Corp. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,28 +20,29 @@
 
 """
 
-import unittest
-import requests
-import json
 import base64
-import sys
-import os
 import datetime
-import mock
-
-from requests import ConnectTimeout, HTTPError
+import json
+import os
+import sys
+import unittest
 from time import sleep
 
+import mock
+import requests
 from cloudant import cloudant, cloudant_bluemix, couchdb, couchdb_admin_party
-from cloudant.client import Cloudant, CouchDB
 from cloudant._client_session import BasicSession, CookieSession
+from cloudant.client import Cloudant, CouchDB
 from cloudant.database import CloudantDatabase
 from cloudant.error import CloudantArgumentError, CloudantClientException
 from cloudant.feed import Feed, InfiniteFeed
+from nose.plugins.attrib import attr
+from requests import ConnectTimeout, HTTPError
 
 from .unit_t_db_base import skip_if_not_cookie_auth, UnitTestDbBase
 from .. import bytes_, str_
 
+
 class CloudantClientExceptionTests(unittest.TestCase):
     """
     Ensure CloudantClientException functions as expected.
@@ -86,10 +87,10 @@ class ClientTests(UnitTestDbBase):
     """
 
     @unittest.skipIf(
-        (os.environ.get('RUN_CLOUDANT_TESTS') is not None or
-        (os.environ.get('ADMIN_PARTY') and os.environ.get('ADMIN_PARTY') == 'true')),
+        ((os.environ.get('ADMIN_PARTY') and os.environ.get('ADMIN_PARTY') == 'true')),
         'Skipping couchdb context manager test'
     )
+    @attr(db='couch')
     def test_couchdb_context_helper(self):
         """
         Test that the couchdb context helper works as expected.
@@ -102,10 +103,10 @@ def test_couchdb_context_helper(self):
             self.fail('Exception {0} was raised.'.format(str(err)))
 
     @unittest.skipUnless(
-        (os.environ.get('RUN_CLOUDANT_TESTS') is None and
-        (os.environ.get('ADMIN_PARTY') and os.environ.get('ADMIN_PARTY') == 'true')),
+        ((os.environ.get('ADMIN_PARTY') and os.environ.get('ADMIN_PARTY') == 'true')),
         'Skipping couchdb_admin_party context manager test'
     )
+    @attr(db='couch')
     def test_couchdb_admin_party_context_helper(self):
         """
         Test that the couchdb_admin_party context helper works as expected.
@@ -599,10 +600,7 @@ def test_db_updates_feed_call(self):
         finally:
             self.client.disconnect()
 
-@unittest.skipUnless(
-    os.environ.get('RUN_CLOUDANT_TESTS') is not None,
-    'Skipping Cloudant client specific tests'
-)
+@attr(db='cloudant')
 class CloudantClientTests(UnitTestDbBase):
     """
     Cloudant specific client unit tests

tests/unit/database_tests.py

@@ -22,25 +22,27 @@
 
 """
 
-import unittest
-import mock
-import requests
 import os
+import unittest
 import uuid
 
+import mock
+import requests
 from cloudant._2to3 import UNICHR
-from cloudant.result import Result, QueryResult
-from cloudant.error import CloudantArgumentError, CloudantDatabaseException
-from cloudant.document import Document
 from cloudant.design_document import DesignDocument
-from cloudant.security_document import SecurityDocument
-from cloudant.index import Index, TextIndex, SpecialIndex
+from cloudant.document import Document
+from cloudant.error import CloudantArgumentError, CloudantDatabaseException
 from cloudant.feed import Feed, InfiniteFeed
-from tests.unit._test_util import LONG_NUMBER
+from cloudant.index import Index, TextIndex, SpecialIndex
+from cloudant.result import Result, QueryResult
+from cloudant.security_document import SecurityDocument
+from nose.plugins.attrib import attr
 
+from tests.unit._test_util import LONG_NUMBER
 from .unit_t_db_base import skip_if_not_cookie_auth, UnitTestDbBase, skip_if_iam
 from .. import unicode_
 
+
 class CloudantDatabaseExceptionTests(unittest.TestCase):
     """
     Ensure CloudantDatabaseException functions as expected.
@@ -79,6 +81,7 @@ def test_raise_with_proper_code_and_args(self):
             raise CloudantDatabaseException(400, 'foo')
         self.assertEqual(cm.exception.status_code, 400)
 
+@attr(db=['cloudant','couch'])
 class DatabaseTests(UnitTestDbBase):
     """
     CouchDatabase/CloudantDatabase unit tests
@@ -780,8 +783,7 @@ def test_get_set_revision_limit(self):
         self.assertNotEqual(new_limit, limit)
         self.assertEqual(new_limit, 1234)
 
-    @unittest.skipIf(os.environ.get('RUN_CLOUDANT_TESTS'),
-        'Skipping since view cleanup is automatic in Cloudant.')
+    @attr(db='couch')
     def test_view_clean_up(self):
         """
         Test cleaning up old view files
@@ -968,10 +970,7 @@ def test_database_request_fails_after_client_disconnects(self):
         finally:
             self.client.connect()
 
-    @unittest.skipIf(not os.environ.get('RUN_CLOUDANT_TESTS') or
-                     (os.environ.get('COUCHDB_VERSION') and
-                     os.environ.get('COUCHDB_VERSION').startswith('1')),
-                     'Skipping test_create_json_index test')
+    @attr(couchapi=2)
     def test_create_json_index(self):
         """
         Ensure that a JSON index is created as expected.
@@ -995,10 +994,7 @@ def test_create_json_index(self):
         self.assertEquals(index['options']['def']['fields'], ['name', 'age'])
         self.assertEquals(index['reduce'], '_count')
 
-    @unittest.skipIf(not os.environ.get('RUN_CLOUDANT_TESTS') or
-                     (os.environ.get('COUCHDB_VERSION') and
-                      os.environ.get('COUCHDB_VERSION').startswith('1')),
-                     'Skipping test_create_json_index test')
+    @attr(couchapi=2)
     def test_delete_json_index(self):
         """
         Ensure that a JSON index is deleted as expected.
@@ -1013,10 +1009,7 @@ def test_delete_json_index(self):
         self.db.delete_query_index('ddoc001', 'json', 'index001')
         self.assertFalse(ddoc.exists())
 
-@unittest.skipUnless(
-    os.environ.get('RUN_CLOUDANT_TESTS') is not None,
-    'Skipping Cloudant specific Database tests'
-)
+@attr(db='cloudant')
 class CloudantDatabaseTests(UnitTestDbBase):
     """
     Cloudant specific Database unit tests

tests/unit/db_updates_tests.py

@@ -16,14 +16,15 @@
 Unit tests for _db_updates feed
 """
 
-import unittest
-from requests import Session
 import json
 import os
+import unittest
 
-from cloudant.feed import Feed
-from cloudant.error import CloudantArgumentError
 from cloudant._2to3 import unicode_
+from cloudant.error import CloudantArgumentError
+from cloudant.feed import Feed
+from nose.plugins.attrib import attr
+from requests import Session
 
 from .unit_t_db_base import UnitTestDbBase
 from .. import BYTETYPE
@@ -104,8 +105,7 @@ def assert_changes_in_db_updates_feed(self, changes):
             self.assertDictEqual(
                 changes[2], {'db_name': self.new_dbs[2].database_name, 'type': 'created'})
 
-@unittest.skipIf(os.environ.get('RUN_CLOUDANT_TESTS'),
-    'Skipping CouchDB _db_updates feed tests')
+@attr(db='couch')
 class CouchDbUpdatesTests(DbUpdatesTestsBase):
     """
     CouchDB _db_updates feed unit tests
@@ -276,8 +276,8 @@ def test_invalid_feed_value(self):
         self.assertTrue(str(cm.exception).startswith(
             'Invalid value (normal) for feed option.'))
 
-@unittest.skipIf(not os.environ.get('RUN_CLOUDANT_TESTS') or
-    os.environ.get('SKIP_DB_UPDATES'), 'Skipping Cloudant _db_updates feed tests')
+@attr(db='cloudant')
+@unittest.skipIf(os.environ.get('SKIP_DB_UPDATES'), 'Skipping Cloudant _db_updates feed tests')
 class CloudantDbUpdatesTests(DbUpdatesTestsBase):
     """
     Cloudant _db_updates feed unit tests