Bug 686471 - cfx test_generate doesn't clean up all generated files; …

…r=myk

(cherry picked from commit 75b2998)

python-lib/cuddlefish/docs/generate.py

@@ -17,6 +17,9 @@
 TGZ_FILENAME = "addon-sdk-docs.tgz"
 
 def clean_generated_docs(docs_dir):
+    status_file = os.path.join(docs_dir, "status.md5")
+    if os.path.exists(status_file):
+        os.remove(status_file)
     index_file = os.path.join(docs_dir, "index.html")
     if os.path.exists(index_file):
         os.remove(index_file)
@@ -43,7 +46,7 @@ def generate_docs(env_root, base_url=None, filename=None, stdout=sys.stdout):
     # and return its URL
     if filename:
         return generate_named_file(env_root, base_url, filename)
-    # if the static docs dir doesn't exist, generate everything
+    # if the generated docs don't exist, generate everything
     if not os.path.exists(os.path.join(docs_dir, "index.html")):
         print >>stdout, "Generating documentation..."
         generate_docs_from_scratch(env_root, base_url, docs_dir)
@@ -58,7 +61,6 @@ def generate_docs(env_root, base_url=None, filename=None, stdout=sys.stdout):
         # if the docs are not up to date, generate everything
         if not docs_are_up_to_date:
             print >>stdout, "Regenerating documentation..."
-            clean_generated_docs(docs_dir)
             generate_docs_from_scratch(env_root, base_url, docs_dir)
             open(os.path.join(env_root, DOCS_DIR, DIGEST), "w").write(current_status)
     return base_url + "index.html"

python-lib/cuddlefish/tests/test_generate.py

@@ -29,7 +29,7 @@ def test_generate_static_docs_does_not_smoke(self):
     def test_generate_docs_does_not_smoke(self):
         test_root = os.path.join(env_root, "python-lib", "cuddlefish", "tests", "static-files")
         docs_root = os.path.join(test_root, "doc")
-        self.clean_generated_docs(docs_root)
+        generate.clean_generated_docs(docs_root)
         new_digest = self.check_generate_regenerate_cycle(test_root, INITIAL_FILESET)
         # touching an MD file under packages **does** cause a regenerate
         os.utime(os.path.join(test_root, "packages", "aardvark", "doc", "main.md"), None)
@@ -50,18 +50,7 @@ def test_generate_docs_does_not_smoke(self):
         os.remove(os.path.join(docs_root, "dev-guide-source", "extra.md"))
         new_digest = self.check_generate_regenerate_cycle(test_root, INITIAL_FILESET, new_digest)
         # remove the files
-        self.clean_generated_docs(docs_root)
-
-    def clean_generated_docs(self, docs_dir):
-        index_file = os.path.join(docs_dir, "index.html")
-        if os.path.exists(index_file):
-            os.remove(index_file)
-        dev_guide_dir = os.path.join(docs_dir, "dev-guide")
-        if os.path.exists(dev_guide_dir):
-            shutil.rmtree(dev_guide_dir)
-        api_doc_dir = os.path.join(docs_dir, "packages")
-        if os.path.exists(api_doc_dir):
-            shutil.rmtree(api_doc_dir)
+        generate.clean_generated_docs(docs_root)
 
     def check_generate_is_skipped(self, test_root, files_to_expect, initial_digest):
         generate.generate_docs(test_root, stdout=StringIO.StringIO())