Merge lp:~cmiller/desktopcouch/couchdb-polutes-its-ini into lp:desktopcouch

[Chad Miller]

The couchdb INI file may be updatec by couchdb to have a hashed password value, so we can not blindly take that to update the bookmark file any more. Now, store the username and password (yes in the INI also, but) in the bookmark file using a parsable format. Now, we can poke the value in initially, and later read the bookmark file to update the bookmark file.

[Stuart Langridge (sil)]

Excellent.

review: Approve

[John O'Brien (jdobrien)]

review: Approve

[Chad Miller (cmiller)]

The couchdb INI file may be updatec by couchdb to have a hashed password value, so we can not blindly take that to update the bookmark file any more. Now, store the username and password (yes in the INI also, but) in the bookmark file using a parsable format. Now, we can poke the value in initially, and later read the bookmark file to update the bookmark file.

[Chad Miller (cmiller)]

The attempt to merge lp:~cmiller/desktopcouch/couchdb-polutes-its-ini into lp:desktopcouch failed.Below is the output from the failed tests.

Apache CouchDB has started, time to relax.
Browse your desktop CouchDB at file:///tmp/tmpCA9l0y/data/couchdb.html
desktopcouch.contacts.tests.test_contactspicker
  TestContactsPicker
    test_can_contruct_contactspicker ... [OK]
desktopcouch.contacts.tests.test_create
  TestCreate
    test_create_many_contacts ... [OK]
    test_head_or_tails ... [OK]
    test_random_bools ... [OK]
desktopcouch.contacts.tests.test_record
  TestContactRecord
    test_contact_record ... [OK]
desktopcouch.pair.tests.test_couchdb_io
  TestCouchdbIo
    test_get_database_names_replicatable ... [OK]
    test_get_database_names_replicatable_bad_server ... [OK]
    test_get_my_host_unique_id ... [ERROR]
    test_mkuri ... [OK]
    test_obsfuscation ... [OK]
    test_put_dynamic_paired_host ... [OK]
    test_put_static_paired_service ... [OK]
desktopcouch.pair.tests.test_network_io
  TestNetworkIO
    test_successful_lifespan ... [OK]
desktopcouch.records.tests.test_couchgrid
  TestCouchGrid
    test_all_from_database ... [OK]
    test_constructor_guarded ... [OK]
    test_new_rows_with_headings ... [OK]
    test_no_headings_or_stored_records ... [OK]
    test_optional_args_no_stored_records ... [OK]
    test_optional_record_type_arg ... [OK]
    test_programatically_add_row ... [OK]
    test_selected_id_property ... [OK]
    test_single_col_from_database ... [OK]
desktopcouch.records.tests.test_field_registry
  TestFieldMapping
    test_mergeable_list_field_mapping ... [OK]
    test_mergeable_list_field_mapping_empty_field ... [OK]
    test_simple_field_mapping ... [OK]
  TestTransformer
    test_from_app ... [OK]
    test_run_doctests ... [OK]
    test_to_app ... [OK]
desktopcouch.records.tests.test_record
  TestRecordFactory
    test_build ... [OK]
  TestRecords
    test_application_annotations ... [OK]
    test_delitem ... ...

=== modified file 'bin/desktopcouch-service'
--- bin/desktopcouch-service	2009-10-14 14:48:25 +0000
+++ bin/desktopcouch-service	2010-02-05 00:09:13 +0000
@@ -46,6 +46,7 @@
 import desktopcouch
 from desktopcouch import local_files
 from desktopcouch import replication
+from desktopcouch.stop_local_couchdb import stop_couchdb
 
 
 class PortAdvertiser(dbus.service.Object):
@@ -104,7 +105,11 @@
         mainloop.run()
 
     finally:
-        if replication_runtime:
-            print "Shutting down, but may be a moment to finish replication."
-            replication.tear_down(*replication_runtime)
+        try:
+            print "Shutting down...",
+            if replication_runtime:
+                replication.tear_down(*replication_runtime)
+        finally:
+            stop_couchdb()
+            print "done."
 

=== modified file 'bin/desktopcouch-stop'
--- bin/desktopcouch-stop	2009-07-24 19:32:52 +0000
+++ bin/desktopcouch-stop	2010-02-05 00:09:13 +0000
@@ -19,18 +19,6 @@
 """
 Stop local CouchDB server.
 """
-import subprocess, sys
-from desktopcouch import local_files
-
-local_exec = local_files.COUCH_EXEC_COMMAND + ["-k"]
-try:
-    retcode = subprocess.call(local_exec, shell=False)
-    if retcode < 0:
-        print >> sys.stderr, "Child was terminated by signal", -retcode
-    elif retcode > 0:
-        print >> sys.stderr, "Child returned", retcode
-except OSError, e:
-    print >> sys.stderr, "Execution failed: %s: %s" % (e, local_exec)
-    exit(1)
-
-
+
+from desktopcouch.stop_local_couchdb import stop_couchdb
+stop_couchdb()

=== modified file 'data/couchdb.tmpl'
--- data/couchdb.tmpl	2009-08-20 12:55:54 +0000
+++ data/couchdb.tmpl	2010-02-05 00:09:13 +0000
@@ -26,7 +26,7 @@
 <h1>Desktop CouchDB</h1>
 <p>Your desktop CouchDB is the data store for many of your applications.
 You can browse around it to see which data your applications are storing.</p>
-<p>You should bookmark this page (by going to <strong>Bookmarks > Bookmark
+<p>You should bookmark this page (by going to <strong>Bookmarks &gt; Bookmark
 This Page</strong> or pressing <strong>Ctrl-D</strong>) so you can easily
 come back to browse your CouchDB again.</p>
 <p>Don't bookmark the CouchDB page itself, because its location may change!</p>
@@ -35,4 +35,4 @@
 there straight away from now on</a> (remember to bookmark this page first!)</p>
 </body>
 </html>
-
+<!-- !![[COUCHDB_USERNAME]]!![[COUCHDB_PASSWORD]]!! -->

=== modified file 'desktopcouch/local_files.py'
--- desktopcouch/local_files.py	2009-12-14 14:52:48 +0000
+++ desktopcouch/local_files.py	2010-02-05 00:09:13 +0000
@@ -29,6 +29,7 @@
 import tempfile
 import random
 import string
+import re
 import gnomekeyring
 try:
     import ConfigParser as configparser
@@ -53,10 +54,16 @@
         # monkeypatch ConfigParser to stop it lower-casing option names
         self._c.optionxform = lambda s: s
 
+        bookmark_file = os.path.join(ctx.db_dir, "couchdb.html")
         try:
+            bookmark_file_contents = open(bookmark_file).read()
+            if "-hashed-" in bookmark_file_contents:
+                raise ValueError("Basic-auth cred lost.")
+            u, p = re.findall("<!-- !!([^!]+)!!([^!]+)!! -->",
+                    bookmark_file_contents)[-1]  # trial run, check sanity.
             self._fill_from_file(self.file_name_used)
             return
-        except (IOError,):
+        except (IOError, ValueError, IndexError):
             pass  # Loading failed.  Let's fill it with sensible defaults.
 
         try:
@@ -123,6 +130,20 @@
         self._fill_from_structure(local)
         self.save_to_file(self.file_name_used)
 
+        fp = open(bookmark_file, "w")
+        try:
+            fp.write("Desktopcouch is not yet started.\n")
+            fp.write("<!-- Couch clobbers useful creds in INI file. -->\n")
+            fp.write("<!-- So, store creds in the place we need it. -->\n")
+            fp.write("<!-- The '!' fmt is perpetual but port varies. -->\n")
+            fp.write("<!-- !!%(admin_username)s!!%(admin_password)s!! -->\n" \
+                    % locals())
+            fp.write("<!-- ^^  Seeded only creds into bookmark file. -->\n")
+            fp.write("<!-- Will flesh out with port when we know it. -->\n")
+            fp.write("<!-- Replacement text also uses creds format. -->\n")
+        finally:
+            fp.close()
+
     # randomly generate tokens and usernames
     @staticmethod
     def _make_random_string(count):

=== modified file 'desktopcouch/records/server_base.py'
--- desktopcouch/records/server_base.py	2010-01-29 22:14:25 +0000
+++ desktopcouch/records/server_base.py	2010-02-05 00:09:13 +0000
@@ -153,8 +153,12 @@
         self.record_factory = record_factory or Record
         self._changes_since = 0
         self._changes_last_used = 0
-        self.report_changes(lambda **_: None)  # Update _changes_since.
+        try:
+            self.report_changes(lambda **_: None)  # Update _changes_since.
+        except IOError:
+            pass
         self._changes_last_used = 0  # Immediate run works.
+            
 
     def _temporary_query(self, map_fun, reduce_fun=None, language='javascript',
             wrapper=None, **options):
@@ -489,6 +493,8 @@
             uri = couchdburi(self._server.resource.uri, self.db.name, "_changes",
                     since=self._changes_since)
             resp, data = self._server.resource.http.request(uri, "GET", "", {})
+            if resp["status"] != '200':
+                raise IOError("HTTP response code %s.\n%s" % (resp["status"], data))
             structure = json.loads(data)
             for change in structure.get("results"):
                 # kw-args can't have unicode keys

=== modified file 'desktopcouch/start_local_couchdb.py'
--- desktopcouch/start_local_couchdb.py	2009-12-16 14:21:09 +0000
+++ desktopcouch/start_local_couchdb.py	2010-02-05 00:09:13 +0000
@@ -42,6 +42,7 @@
 from desktopcouch.records.server import CouchDatabase
 import logging
 import itertools
+import re
 
 
 def process_is_couchdb__linux(pid):
@@ -187,10 +188,15 @@
                 # than inefficiently just overwriting it regardless
                 db.add_view(view_name, mapjs, reducejs, dd_name)
 
-def write_bookmark_file(username, password, port, ctx=local_files.DEFAULT_CONTEXT):
+def update_bookmark_file(port, ctx=local_files.DEFAULT_CONTEXT):
     """Write out an HTML document that the user can bookmark to find their DB"""
     bookmark_file = os.path.join(ctx.db_dir, "couchdb.html")
 
+    try:
+        username, password = re.findall("<!-- !!([^!]+)!!([^!]+)!! -->", open(bookmark_file).read())[-1]
+    except ValueError:
+        raise IOError("Bookmark file is corrupt.  Username/password are missing.")
+
     if os.path.exists(
             os.path.join(os.path.split(__file__)[0], "../data/couchdb.tmpl")):
         bookmark_template = os.path.join(
@@ -208,9 +214,7 @@
 
     fp = open(bookmark_file, "w")
     try:
-        if port is None:
-            fp.write("<html><body><p>Sorry, desktop couchdb does is not running.</body></html>\n")
-        else:
+        if port is not None:
             out = html.replace("[[COUCHDB_PORT]]", str(port))
             out = out.replace("[[COUCHDB_USERNAME]]", username)
             out = out.replace("[[COUCHDB_PASSWORD]]", password)
@@ -222,14 +226,13 @@
 
 def start_couchdb(ctx=local_files.DEFAULT_CONTEXT):
     """Execute each step to start a desktop CouchDB."""
-    username, password = local_files.get_admin_credentials(ctx=ctx)
     pid, port = run_couchdb(ctx=ctx)
     # Note that we do not call update_design_documents here. This is because
     # Couch won't actually have started yet, so when update_design_documents
     # calls the Records API, that will call back into get_port and we end up
     # starting Couch again. Instead, get_port calls update_design_documents
     # *after* Couch startup has occurred.
-    write_bookmark_file(username, password, port, ctx=ctx)
+    update_bookmark_file(port, ctx=ctx)
     return pid
 
 

=== modified file 'desktopcouch/stop_local_couchdb.py'
--- desktopcouch/stop_local_couchdb.py	2009-11-24 14:55:27 +0000
+++ desktopcouch/stop_local_couchdb.py	2010-02-05 00:09:13 +0000
@@ -15,38 +15,27 @@
 # along with desktopcouch.  If not, see <http://www.gnu.org/licenses/>.
 #
 # Author: Chad Miller <[e-mail]>
+#         Stuart Langridge <[e-mail]>
+
 """
 Stop local CouchDB server.
 """
 
-import os
-import desktopcouch
-import time
-import signal
-import errno
-
-def stop_couchdb(pid=None):
-    by_pid = pid
-    if pid is None:
-        pid = desktopcouch.find_pid(start_if_not_running=False)
-    while pid is not None:
-        try:
-            os.kill(pid, signal.SIGTERM)
-        except OSError, e:
-            if e.errno == errno.ESRCH:
-                break
-            raise
-
-        for retry in xrange(300):
-            try:
-                os.kill(pid, 0)  # test existence. sig-zero is special.
-            except OSError:
-                break
-            time.sleep(0.01)
-        if by_pid:
-            pid = None
-        else:
-            pid = desktopcouch.find_pid(start_if_not_running=False)
+import subprocess, sys
+from desktopcouch import local_files
+
+def stop_couchdb(ctx=local_files.DEFAULT_CONTEXT):
+    local_exec = ctx.couch_exec_command + ["-k"]
+    try:
+        retcode = subprocess.call(local_exec, shell=False)
+        if retcode < 0:
+            print >> sys.stderr, "Child was terminated by signal", -retcode
+        elif retcode > 0:
+            print >> sys.stderr, "Child returned", retcode
+    except OSError, e:
+        print >> sys.stderr, "Execution failed: %s: %s" % (e, local_exec)
+        exit(1)
+
 
 if __name__ == "__main__":
     stop_couchdb()

=== modified file 'desktopcouch/tests/__init__.py'
--- desktopcouch/tests/__init__.py	2009-11-11 16:24:22 +0000
+++ desktopcouch/tests/__init__.py	2010-02-05 00:09:13 +0000
@@ -29,8 +29,7 @@
         os.environ["XDG_CONFIG_DIRS"] = SOURCE_TREE_ETC_FOLDER
 
     def stop_test_couch(temp_dir, ctx):
-        pid = read_pidfile(ctx)
-        stop_couchdb(pid=pid)
+        stop_couchdb(ctx)
         shutil.rmtree(temp_dir)
 
     start_couchdb(ctx=new_context)