launchpad-reviewers team mailing list archive

[Ursula Junque <ursinha@xxxxxxxxxxx>]

Ursula Junque has proposed merging lp:~ursinha/qa-tagger/add-hacking into lp:qa-tagger.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)
Related bugs:
  #688092 It's too hard to start hacking on qa-tagger
  https://bugs.launchpad.net/bugs/688092

For more details, see:
https://code.launchpad.net/~ursinha/qa-tagger/add-hacking/+merge/46549

This branch adds a HACKING.txt file, and improves the README.txt one, so hacking in qa-tagger could be easier. This is bug 688092.
-- 
https://code.launchpad.net/~ursinha/qa-tagger/add-hacking/+merge/46549
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~ursinha/qa-tagger/add-hacking into lp:qa-tagger.

=== added file 'HACKING.txt'
--- HACKING.txt	1970-01-01 00:00:00 +0000
+++ HACKING.txt	2011-01-17 23:34:54 +0000
@@ -0,0 +1,46 @@
+Introduction
+============
+
+These are basic guidelines for hacking on the qa-tagger project.
+
+
+Getting help
+------------
+
+If you find bugs in this package, you can report them here:
+
+    https://launchpad.net/qa-tagger
+
+
+Building and Running
+====================
+
+Instructions on how to build and create a distributable package can be found in the README.txt file.
+
+
+Coding
+======
+
+qa-tagger follows pretty much the Launchpad hacking guidelines. There are no specific development docs, but the
+code is documented well enough to provide needed information on how to proceed.
+
+Launchpad hacking guidelines can be found in:
+
+    http://dev.launchpad.net/Hacking
+
+
+Testing changes
+===============
+
+To test changes, run a `make`, and then:
+
+ $ ./bin/test [-t testname]
+
+or no parameters to have a full test run.
+
+
+Debugging
+=========
+
+There are no implicit mechanisms to debug changes, but tag-bugs has two levels of log messages: -v and -V.
+To see what's happening while tag-bugs is running, -V should be useful to display step by step of what's being done.

=== modified file 'README.txt'
--- README.txt	2010-08-31 01:46:07 +0000
+++ README.txt	2011-01-17 23:34:54 +0000
@@ -14,7 +14,7 @@
 
 
 Installation
-------------
+============
 
 You can install the qa-tagger application as a stand-alone application that
 does not depend on the system's Python packages, or in development mode, where
@@ -50,3 +50,42 @@
  $ ls qa-tagger*.tgz
 
 Note: In order to make dist, you have to set up the public branch for the branch you're deploying. Otherwise make dist will fail.
+
+
+Running
+=======
+
+After running make, the executable script can be found at ./bin/tag-bugs. 
+
+
+Basic usage
+-----------
+
+ $ ./bin/tag-bugs -m MILESTONE_NAME -b BRANCH_NAME -p PROJECT_NAME
+
+Where milestone name is the short name of the milestone, e.g. 11.02, branch name is the branch nick that the script
+should look for in Launchpad, and project name is the project name in Launchpad. If not given, the script assumes
+the project is Launchpad.
+
+If you want to test it without having revision files or launchpad bugs changed, use the --dry-run option.
+
+If you want reports to be generated, provide the --reports-dir option. --reports-dir needs to be the path of an
+existing folder.
+
+
+tag-nator-o-matic.sh
+--------------------
+
+tag-nator-o-matic.sh is the wrapper script that runs tag-bugs to all projects and branches monitored in Launchpad QA process.
+It needs a current-milestone file, that should contain the milestone name.
+
+If you intent to start monitoring a given branch from an specific revision number, and not since revision 1, you'll need a
+file in qa-tagger root to tell the script where to start. File name should look like "last-revno-PROJECTNAME-BRANCHNAME", and
+must contain the revision you want the script to start, less one. E.g.: 12345 is the first revision you want to monitor,
+file should contain 12344.
+
+ $ cat last-revno-launchpad-stable
+ 12344
+
+
+

=== modified file 'qatagger/tests/test_testplan.py'
--- qatagger/tests/test_testplan.py	2010-11-17 21:02:41 +0000
+++ qatagger/tests/test_testplan.py	2011-01-17 23:34:54 +0000
@@ -1058,7 +1058,9 @@
     def test___init__staging(self):
         a_branch = ProjectBranches("launchpad", "db-stable")
         # Note that its a little ugly to figure this out in the constructor.
-        self.assertIsInstance(a_branch.prod_deployment, LPNetDeployment)
+        # XXX Ursinha: Because of the workaround for bug 674829,
+        # prod_deployment to db-stable is a hardcoded MergeDeployment.
+        self.assertIsInstance(a_branch.prod_deployment, MergeDeployment)
         self.assertIsInstance(a_branch.qa_deployment, LPStagingDeployment)
 
     def test___init___explicit_user(self):