Merge lp:~abentley/charmworld/restore-questions into lp:~juju-jitsu/charmworld/trunk

[Aaron Bentley]

Restore QA questions to migrations.

This branch restores the QA questions to the migrations. I had deleted them because they were old migrations. Most migrations describe a change to apply, so they can be deleted once no databases exist that lack the change. But the QA questions are a desired state, and so they must be applied to all databases, even new ones.

[Brad Crittenden (bac)]

Hi Aaron, the code and tests look good to me. I found two typos, one legacy. Thanks.

typo: mirgrations
typo: comfigure

review: Approve

[lp:~abentley/charmworld/restore-questions]

335. By Aaron Bentley on 2013-08-06

Fix typos.

=== modified file 'Makefile'
--- Makefile	2013-07-18 21:33:26 +0000
+++ Makefile	2013-08-06 13:54:26 +0000
@@ -91,17 +91,17 @@
 # ###################
 
 test: test.ini $(INI) bin/nosetests
-	$(NOSE) charmworld migrations
+	$(NOSE) charmworld
 
 testid: test.ini bin/nosetests
 	# Run specific nose id tests.
 	# To set up the index you must run `make testid` once to completion to
 	# setup the index.  Then you can run a group of tests like:
 	# Call with `ID="3 5" make testid`
-	$(NOSE) -v -s -x --with-id $(ID) charmworld migrations
+	$(NOSE) -v -s -x --with-id $(ID) charmworld
 
 testdebug: test.ini bin/nosetests
-	$(NOSE) --with-id --pdb --pdb-failures charmworld migrations
+	$(NOSE) --with-id --pdb --pdb-failures charmworld
 
 check: clear_ini clean sysdeps install testid
 
 
=== renamed directory 'migrations' => 'charmworld/migrations'
=== modified file 'charmworld/migrations/migrate.py'
--- migrations/migrate.py	2013-07-15 21:31:05 +0000
+++ charmworld/migrations/migrate.py	2013-08-06 13:54:26 +0000
@@ -389,6 +389,10 @@
             print "Updated the datastore to version: {0}".format(new_version)
 
 
+def get_migration_path():
+    return join(abspath(dirname(__file__)), 'versions')
+
+
 def main():
     """Target for the console entry point."""
     configure_logging()
@@ -396,8 +400,7 @@
     ini = get_ini()
 
     # Add the migration path to the ini.
-    migration_path = join(abspath(dirname(__file__)), 'versions')
-    ini['migrations'] = migration_path
+    ini['migrations'] = get_migration_path()
 
     args.func(ini, args)
 
 
=== added file 'charmworld/migrations/versions/011_ensure_category_questions.py'
--- charmworld/migrations/versions/011_ensure_category_questions.py	1970-01-01 00:00:00 +0000
+++ charmworld/migrations/versions/011_ensure_category_questions.py	2013-08-06 13:54:26 +0000
@@ -0,0 +1,15 @@
+# Copyright 2013 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+from charmworld.qa_questions import iter_categories
+
+
+def upgrade(db, index_client):
+    """Update each category of questions from new_category_data.
+
+    This update elaborates on the 001_* migration. Subsequent qa form
+    migrations can replace new_category_data and run this same method.
+    """
+    db.qa.drop()
+    for category_dict in iter_categories():
+        db.qa.insert(category_dict)
 
=== modified file 'charmworld/migrations/versions/tests/test_migrations.py'
--- migrations/versions/tests/test_migrations.py	2013-07-22 19:18:21 +0000
+++ charmworld/migrations/versions/tests/test_migrations.py	2013-08-06 13:54:26 +0000
@@ -6,8 +6,8 @@
 )
 from charmworld.models import CharmSource
 from charmworld.testing import MongoTestBase
-import migrations.migrate
-from migrations.migrate import Versions
+from charmworld.migrations import migrate
+from charmworld.migrations.migrate import Versions
 
 
 def fake():
@@ -18,12 +18,12 @@
 
     def setUp(self):
         super(MigrationTestBase, self).setUp()
-        self.versions = Versions('migrations/versions/')
-        true_configure_logging = migrations.migrate.configure_logging
-        migrations.migrate.configure_logging = fake
+        self.versions = Versions(migrate.get_migration_path())
+        true_configure_logging = migrate.configure_logging
+        migrate.configure_logging = fake
         self.addCleanup(
-            setattr, migrations.migrate,
-            'comfigure_logging', true_configure_logging)
+            setattr, migrate,
+            'configure_logging', true_configure_logging)
 
 
 class TestMigration010(MigrationTestBase):
@@ -78,3 +78,14 @@
             self.index_client.get('e')
         self.assertEqual({'_id': 'e', 'config': ['a']},
                          self.db.charms.find_one({'_id': 'e'}))
+
+
+class TestMigration011(MigrationTestBase):
+
+    def test_migration(self):
+        self.use_index_client()
+        source = CharmSource.from_request(self)
+        self.assertItemsEqual([], self.db.qa.find())
+        self.versions.run_migration(self.db, self.index_client,
+                                    '011_ensure_category_questions.py')
+        self.assertIn('reliable', [cat['name'] for cat in self.db.qa.find()])
 
=== added file 'charmworld/qa_questions.py'
--- charmworld/qa_questions.py	1970-01-01 00:00:00 +0000
+++ charmworld/qa_questions.py	2013-08-06 13:54:26 +0000
@@ -0,0 +1,145 @@
+# Copyright 2012, 2013 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+# -*- coding: utf-8 -*-
+"""
+Load qa questions into the collection for populating the scoring parts of
+the quality assessment form.
+
+"""
+
+
+def iter_categories():
+    """Complete this function with work to be done for the migration/update.
+
+    db is the pymongo db instance for our datastore. Charms are in db.charms
+    for instance.
+    """
+
+    initial = [
+        (
+            u'reliable',
+            u'Reliable',
+            [
+                (u'Check for integrity from upstream source', 1, u''),
+                (u'Fail gracefully if upstream source goes missing', 1, u''),
+                (u'Contain a suite of tests with the charm that pass', 1, u''),
+                (u'Passes tests from Jenkins on jujucharms.com', 1, u''),
+            ]
+        ),
+
+        (
+            u'secure',
+            u'Secure',
+            [
+                (u'Contain a well tested AppArmor profile', 1, ''),
+                (u'Conform to security policies of the charm store', 1,
+                 'Tight access control'),
+                (u"Doesn't run as root", 1, ''),
+                (u'Per instance or service access control', 1, ''),
+            ]
+        ),
+
+        (
+            u'flexible',
+            u'Flexible',
+            [
+                (
+                    u'Contain opinionated tuning options', 1,
+                    u'Examples (depends on the service): "safe", "default",'
+                    ' "fast", "real fast, not so safe". Don\'t expose every'
+                    ' configuration, pick those that reflect real world usage.'
+                    ' Make it so I don\'t have to read the book.'
+                ),
+                (u'Use existing interfaces with other charms', 1,
+                 u'Highly relatable'),
+            ]
+        ),
+
+        (
+            u'data_handling',
+            u'Data Handling',
+            [
+                (u'Integrate data storage best practices', 1,
+                 u'Backups based on service usage'),
+                (u"Handle the service's user data", 1, u'Version control'),
+                (u"Handle the service's user data", 1,
+                 u'Automated snapshots and backup.'),
+            ]
+        ),
+
+        (
+            u'scalable',
+            u'Scaleable',
+            [
+                (u"Responds to add-unit based on the service's needs", 1,
+                 u'Configuration should not require additional steps to scale'
+                 ' horizontally'),
+                (u'Be tested with a real workload, not just a synthetic'
+                 ' benchmark', 1, ''),
+                (u'From upstream and existing devops practices for that'
+                 ' service', 1, ''),
+                (u'Community peer reviewed', 1, ''),
+                (u'Have a configure option for most performant configuration'
+                 ' if not the default', 1, ''),
+            ]
+        ),
+
+        (
+            u'easy_deploy',
+            u'Easy to Deploy',
+            [
+                (u'README with examples of use for a typical workload', 1, ''),
+                (u'README with examples of use for workloads at scale', 1, ''),
+                (u'README with examples of use recommend best-practice'
+                 ' relationships', 1, ''),
+                (u'Allow installation from pure upstream source', 1, ''),
+                (u'Allow installation from your local source', 1, ''),
+                (u'Allow installation from PPA (if available)', 1, ''),
+                (u'Allow installation from the Ubuntu repository', 1, ''),
+            ]
+        ),
+
+        (
+            u'responsive',
+            u'Responsive to DevOps Needs',
+            [
+                (u'Allow for easy upgrade via juju upgrade-charm', 1, ''),
+                (u'Allow upgrading the service itself.', 1, ''),
+                (u'Responsive to user bug reports and concerns', 1, ''),
+                (u'Maintainable, easy to read and modify', 1, ''),
+            ]
+        ),
+
+        (
+            u'upstream',
+            u'Upstream Friendly',
+            [
+                (u'Follow upstream best practices', 1,
+                 u'Provide an option for a barebones "pure upstream"'
+                 ' configuration'),
+                (u'Should go lock-step with deployment recommendations', 1,
+                 u'Provide tip-of-trunk testing if feasible'),
+                (u'Fresh charm on release day!', 1, ''),
+                (
+                    u"Endeavour to be upstream's recommended way to deploy"
+                    ' that service in the cloud (website mention or'
+                    ' something)', 1, ''
+                ),
+            ]
+        ),
+    ]
+
+    """Add the sample data into the db."""
+    for cat in initial:
+        category_dict = {
+            'name': cat[0],
+            'description': cat[1],
+            'questions': [{
+                'id': '{0}_{1}'.format(cat[0].lower(), i),
+                'description': q[0],
+                'points': q[1],
+                'extended_description': q[2]
+            } for i, q in enumerate(cat[2])]
+        }
+        yield category_dict
 
=== modified file 'setup.py'
--- setup.py	2013-06-28 20:56:31 +0000
+++ setup.py	2013-08-06 13:54:26 +0000
@@ -36,7 +36,7 @@
       enqueue = charmworld.jobs.lp:main
       dequeue = charmworld.jobs.lp:dequeue
       ingest-queued = charmworld.jobs.worker:main
-      migrations = migrations.migrate:main
+      migrations = charmworld.migrations.migrate:main
       es-update = charmworld.search:update_main
       sync-index = charmworld.models:sync_index
       [beaker.backends]