Updated Travis CI and unit tests to run against CouchDB 2.1.1

Author: emlaver

.travis.yml

@@ -1,3 +1,5 @@
+sudo: required
+
 language: python
 
 python:
@@ -9,9 +11,20 @@ env:
   - ADMIN_PARTY=false
 
 services:
-  - couchdb
+  - docker
+
+before_install:
+  - docker pull apache/couchdb:2.1.1
+  - docker run -d -it -p 5984:5984 apache/couchdb:2.1.1 --with-admin-party-please --with-haproxy
 
 install: "pip install -r requirements.txt && pip install -r test-requirements.txt"
+
+before_script:
+    # Make sure CouchDB is up
+    - while [ $? -ne 0 ]; do sleep 1 && curl -v http://localhost:5984; done
+    - curl -X PUT http://localhost:5984/_users
+    - curl -X PUT http://localhost:5984/_replicator
+
 # command to run tests
 script:
     - pylint ./src/cloudant

CHANGES.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+- [IMPROVED] Updated Travis CI and unit tests to run against CouchDB 2.1.1.
+
 # 2.8.1 (2018-02-16)
 
 - [FIXED] Installation failures of 2.8.0 caused by missing VERSION file in distribution.

tests/unit/changes_tests.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2016 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.
@@ -24,7 +24,7 @@
 from cloudant.feed import Feed
 from cloudant.document import Document
 from cloudant.design_document import DesignDocument
-from cloudant.error import CloudantArgumentError, CloudantException
+from cloudant.error import CloudantArgumentError
 from cloudant._2to3 import unicode_
 
 from .unit_t_db_base import UnitTestDbBase
@@ -100,12 +100,7 @@ def test_get_raw_content(self):
             self.assertIsInstance(raw_line, BYTETYPE)
             raw_content.append(raw_line)
         changes = json.loads(''.join([unicode_(x) for x in raw_content]))
-        if self.cloudant_test:
-            self.assertSetEqual(
-                set(changes.keys()), set(['results', 'last_seq', 'pending']))
-        else:
-            self.assertSetEqual(
-                set(changes.keys()), set(['results', 'last_seq']))
+        self.assertSetEqual(set(changes.keys()), set(['results', 'last_seq', 'pending']))
         results = list()
         for result in changes['results']:
             self.assertSetEqual(set(result.keys()), set(['seq', 'changes', 'id']))
@@ -223,29 +218,25 @@ def test_get_raw_feed_with_heartbeat(self):
 
     def test_get_feed_descending(self):
         """
-        Test getting content back for a descending feed.  When testing with
-        Cloudant the sequence identifier is in the form of 
-        <number prefix>-<random char seq>.  Often times the number prefix sorts
-        as expected when using descending but sometimes the number prefix is
-        repeated.  In these cases the check is to see if the following random
-        character sequence suffix is longer than its predecessor.
+        Test getting content back for a descending feed.  When testing, the sequence
+        identifier is in the form of <number prefix>-<random char seq>.  Often times
+        the number prefix sorts as expected when using descending but sometimes the
+        number prefix is repeated.  In these cases the check is to see if the following
+        random character sequence suffix is longer than its predecessor.
         """
         self.populate_db_with_documents(50)
         feed = Feed(self.db, descending=True)
         seq_list = list()
         last_seq = None
         for change in feed:
             if last_seq:
-                if self.cloudant_test:
-                    current = int(change['seq'][0: change['seq'].find('-')])
-                    last = int(last_seq[0:last_seq.find('-')])
-                    try:
-                        self.assertTrue(current < last)
-                    except AssertionError:
-                        self.assertEqual(current, last)
-                        self.assertTrue(len(change['seq']) > len(last_seq))
-                else:
-                    self.assertTrue(change['seq'] < last_seq)
+                current = int(change['seq'][0: change['seq'].find('-')])
+                last = int(last_seq[0:last_seq.find('-')])
+                try:
+                    self.assertTrue(current < last)
+                except AssertionError:
+                    self.assertEqual(current, last)
+                    self.assertTrue(len(change['seq']) > len(last_seq))
             seq_list.append(change['seq'])
             last_seq = change['seq']
         self.assertEqual(len(seq_list), 50)
@@ -303,8 +294,6 @@ def test_get_feed_using_style_all_docs(self):
         changes = list()
         for change in feed:
             self.assertSetEqual(set(change.keys()), set(['seq', 'changes', 'id']))
-            if not self.cloudant_test:
-                self.assertEqual(len(change['changes']), 2)
             changes.append(change)
         expected = set(['julia000', 'julia001', 'julia002'])
         self.assertSetEqual(set([x['id'] for x in changes]), expected)

tests/unit/db_updates_tests.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2016 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.
@@ -22,9 +22,7 @@
 import os
 
 from cloudant.feed import Feed
-from cloudant.document import Document
-from cloudant.design_document import DesignDocument
-from cloudant.error import CloudantArgumentError, CloudantException
+from cloudant.error import CloudantArgumentError
 from cloudant._2to3 import unicode_
 
 from .unit_t_db_base import UnitTestDbBase
@@ -34,25 +32,63 @@ class DbUpdatesTestsBase(UnitTestDbBase):
     """
     Common _db_updates tests methods
     """
-
+    
     def setUp(self):
         """
         Set up test attributes
         """
         super(DbUpdatesTestsBase, self).setUp()
         self.client.connect()
+        self.db_names = list()
         self.new_dbs = list()
+        self.create_db_updates()
+        self.create_dbs()
 
     def tearDown(self):
         """
         Reset test attributes
         """
+        test_dbs_deleted = False
+        changes = list()
         [db.delete() for db in self.new_dbs]
+        # Check the changes in the _db_updates feed to assert that the test databases are deleted
+        while not test_dbs_deleted:
+            feed = Feed(self.client, timeout=1000)
+            for change in feed:
+                if change['db_name'] in self.db_names and change['type'] == 'deleted':
+                    changes.append(change)
+                if len(changes) == 2:
+                    test_dbs_deleted = True
+                    feed.stop()
+        self.delete_db_updates()
         self.client.disconnect()
         super(DbUpdatesTestsBase, self).tearDown()
 
-    def create_dbs(self, count=3):
-        self.new_dbs += [(self.client.create_database(self.dbname())) for x in range(count)]
+    def create_dbs(self):
+        self.db_names = [self.dbname() for x in range(2)]
+        self.new_dbs += [self.client.create_database(dbname) for dbname in self.db_names]
+        # Verify that all created databases are listed in _db_updates
+        all_dbs_exist = False
+        while not all_dbs_exist:
+            changes = list()
+            feed = Feed(self.client, timeout=1000)
+            for change in feed:
+                changes.append(change)
+                if len(changes) == 3:
+                    all_dbs_exist = True
+                    feed.stop()
+
+    def assert_changes_in_db_updates_feed(self, changes):
+        """
+        Assert that databases created in setup for db_updates_tests exist when looping through _db_updates feed
+        Note: During the creation of _global_changes database, a doc called '_dbs' is created and seen in _db_updates
+        """
+        self.dbs = ['_dbs', self.new_dbs[0].database_name, self.new_dbs[1].database_name]
+        types = ['created', 'updated']
+        for doc in changes:
+            self.assertIsNotNone(doc['seq'])
+            self.assertTrue(doc['db_name'] in self.dbs)
+            self.assertTrue(doc['type'] in types)
 
 @unittest.skipIf(os.environ.get('RUN_CLOUDANT_TESTS'),
     'Skipping CouchDB _db_updates feed tests')
@@ -80,45 +116,25 @@ def test_stop_iteration_of_continuous_feed_with_heartbeat(self):
         feed = Feed(self.client, feed='continuous', timeout=100)
         changes = list()
         for change in feed:
-            if not change:
-                if not self.new_dbs:
-                    self.create_dbs(5)
-                else:
-                    continue
-            else:
-                changes.append(change)
-                if len(changes) == 3:
-                    feed.stop()
-        self.assertEqual(len(self.new_dbs), 5)
+            changes.append(change)
+            if len(changes) == 3:
+                feed.stop()
+        self.assert_changes_in_db_updates_feed(changes)
         self.assertEqual(len(changes), 3)
-        self.assertDictEqual(
-            changes[0], {'db_name': self.new_dbs[0].database_name, 'type': 'created'})
-        self.assertDictEqual(
-            changes[1], {'db_name': self.new_dbs[1].database_name, 'type': 'created'})
-        self.assertDictEqual(
-            changes[2], {'db_name': self.new_dbs[2].database_name, 'type': 'created'})
 
     def test_get_raw_content(self):
         """
         Test getting raw feed content
         """
-        feed = Feed(self.client, raw_data='True', feed='continuous', timeout=100)
+        feed = Feed(self.client, raw_data=True, feed='continuous', timeout=100)
         raw_content = list()
         for raw_line in feed:
             self.assertIsInstance(raw_line, BYTETYPE)
-            if not raw_line:
-                self.create_dbs(3)
-            else:
-                raw_content.append(raw_line)
-                if len(raw_content) == 3:
-                    feed.stop()
+            raw_content.append(raw_line)
+            if len(raw_content) == 3:
+                feed.stop()
         changes = [json.loads(unicode_(x)) for x in raw_content]
-        self.assertDictEqual(
-            changes[0], {'db_name': self.new_dbs[0].database_name, 'type': 'created'})
-        self.assertDictEqual(
-            changes[1], {'db_name': self.new_dbs[1].database_name, 'type': 'created'})
-        self.assertDictEqual(
-            changes[2], {'db_name': self.new_dbs[2].database_name, 'type': 'created'})
+        self.assert_changes_in_db_updates_feed(changes)
 
     def test_get_longpoll_feed_as_default(self):
         """
@@ -127,10 +143,10 @@ def test_get_longpoll_feed_as_default(self):
         feed = Feed(self.client, timeout=1000)
         changes = list()
         for change in feed:
-            self.assertIsNone(change)
+            self.assertIsNotNone(change)
             changes.append(change)
-        self.assertEqual(len(changes), 1)
-        self.assertIsNone(changes[0])
+        self.assert_changes_in_db_updates_feed(changes)
+        self.assertEqual(len(changes), 3)
 
     def test_get_longpoll_feed_explicit(self):
         """
@@ -140,18 +156,25 @@ def test_get_longpoll_feed_explicit(self):
         feed = Feed(self.client, timeout=1000, feed='longpoll')
         changes = list()
         for change in feed:
-            self.assertIsNone(change)
+            self.assertIsNotNone(change)
             changes.append(change)
-        self.assertEqual(len(changes), 1)
-        self.assertIsNone(changes[0])
+        self.assert_changes_in_db_updates_feed(changes)
+        self.assertEqual(len(changes), 3)
 
     def test_get_continuous_with_timeout(self):
         """
         Test getting content back for a "continuous" feed with timeout set
         and no heartbeat
         """
         feed = Feed(self.client, feed='continuous', heartbeat=False, timeout=1000)
-        self.assertListEqual([x for x in feed], [])
+        changes = list()
+        for change in feed:
+            self.assertIsNotNone(change)
+            changes.append(change)
+            if len(changes) == 3:
+                feed.stop()
+        self.assert_changes_in_db_updates_feed(changes)
+        self.assertEqual(len(changes), 3)
 
     def test_invalid_argument(self):
         """
@@ -249,7 +272,6 @@ def test_stop_iteration_of_continuous_feed_using_since_now(self):
         feed = Feed(self.client, feed='continuous', since='now')
         count = 0
         changes = list()
-        self.create_dbs(3)
         for change in feed:
             self.assertTrue(all(x in change for x in ('seq', 'type')))
             changes.append(change)
@@ -281,7 +303,6 @@ def test_get_normal_feed_default(self):
         Test getting content back for a "normal" feed without feed option.  Also
         using limit since we don't know how many updates have occurred on client.
         """
-        self.create_dbs(3)
         feed = Feed(self.client, limit=3)
         changes = list()
         for change in feed:
@@ -296,7 +317,6 @@ def test_get_normal_feed_explicit(self):
         Test getting content back for a "normal" feed using feed option.  Also
         using limit since we don't know how many updates have occurred on client.
         """
-        self.create_dbs(3)
         feed = Feed(self.client, feed='normal', limit=3)
         changes = list()
         for change in feed:
@@ -310,7 +330,6 @@ def test_get_longpoll_feed(self):
         """
         Test getting content back for a "longpoll" feed
         """
-        self.create_dbs(3)
         feed = Feed(self.client, feed='longpoll', limit=3)
         changes = list()
         for change in feed: