Add performance test when finding asset metadata.

Re-factor report generation and add report for "find" performance test.

common/lib/xmodule/xmodule/modulestore/perf_tests/test_asset_import_export.py

@@ -10,7 +10,9 @@ from shutil import rmtree
 import ddt
 #from nose.plugins.attrib import attr
 
+from nose.plugins.skip import SkipTest
 from xmodule.assetstore import AssetMetadata
+from xmodule.modulestore import ModuleStoreEnum
 from xmodule.modulestore.xml_importer import import_from_xml
 from xmodule.modulestore.xml_exporter import export_to_xml
 from xmodule.modulestore.tests.test_cross_modulestore_import_export import (
@@ -23,15 +25,10 @@ from xmodule.modulestore.perf_tests.generate_asset_xml import make_asset_xml, va
 
 # The dependency below needs to be installed manually from the development.txt file, which doesn't
 # get installed during unit tests!
-#from code_block_timer import CodeBlockTimer
-
-
-class CodeBlockTimer(object):
-    """
-    To fake out the tests below, this class definition is used. Remove it when uncommenting above.
-    """
-    def __init__(self, desc):
-        pass
+try:
+    from code_block_timer import CodeBlockTimer
+except ImportError:
+    CodeBlockTimer = None
 
 # Number of assets saved in the modulestore per test run.
 ASSET_AMOUNT_PER_TEST = (1, 10, 100, 1000, 10000)
@@ -42,6 +39,13 @@ COURSE_NAME = 'manual-testing-complete'
 # A list of courses to test - only one.
 TEST_COURSE = (COURSE_NAME, )
 
+ALL_SORTS = (
+    ('displayname', ModuleStoreEnum.SortOrder.ascending),
+    ('displayname', ModuleStoreEnum.SortOrder.descending),
+    ('uploadDate', ModuleStoreEnum.SortOrder.ascending),
+    ('uploadDate', ModuleStoreEnum.SortOrder.descending),
+)
+
 # pylint: disable=invalid-name
 TEST_DIR = path(__file__).dirname()
 PLATFORM_ROOT = TEST_DIR.parent.parent.parent.parent.parent.parent
@@ -80,10 +84,13 @@ class CrossStoreXMLRoundtrip(unittest.TestCase):
         ASSET_AMOUNT_PER_TEST
     ))
     @ddt.unpack
-    def test_generate_timings(self, source_ms, dest_ms, num_assets):
+    def test_generate_import_export_timings(self, source_ms, dest_ms, num_assets):
         """
         Generate timings for different amounts of asset metadata and different modulestores.
         """
+        if CodeBlockTimer is None:
+            raise SkipTest("CodeBlockTimer undefined.")
+
         desc = "XMLRoundTrip:{}->{}:{}".format(
             SHORT_NAME_MAP[source_ms],
             SHORT_NAME_MAP[dest_ms],
@@ -140,3 +147,89 @@ class CrossStoreXMLRoundtrip(unittest.TestCase):
                                     create_course_if_not_present=True,
                                     raise_on_failure=True,
                                 )
+
+
+@ddt.ddt
+# Eventually, exclude this attribute from regular unittests while running *only* tests
+# with this attribute during regular performance tests.
+# @attr("perf_test")
+@unittest.skip
+class FindAssetTest(unittest.TestCase):
+    """
+    This class exists to time asset finding in different modulestore
+    classes with different amounts of asset metadata.
+    """
+
+    # Use this attribute to skip this test on regular unittest CI runs.
+    perf_test = True
+
+    def setUp(self):
+        super(FindAssetTest, self).setUp()
+        self.export_dir = mkdtemp()
+        self.addCleanup(rmtree, self.export_dir, ignore_errors=True)
+
+    @ddt.data(*itertools.product(
+        MODULESTORE_SETUPS,
+        ASSET_AMOUNT_PER_TEST,
+    ))
+    @ddt.unpack
+    def test_generate_find_timings(self, source_ms, num_assets):
+        """
+        Generate timings for different amounts of asset metadata and different modulestores.
+        """
+        if CodeBlockTimer is None:
+            raise SkipTest("CodeBlockTimer undefined.")
+
+        desc = "FindAssetTest:{}:{}".format(
+            SHORT_NAME_MAP[source_ms],
+            num_assets,
+        )
+
+        with CodeBlockTimer(desc):
+
+            with CodeBlockTimer("fake_assets"):
+                # First, make the fake asset metadata.
+                make_asset_xml(num_assets, ASSET_XML_PATH)
+                validate_xml(ASSET_XSD_PATH, ASSET_XML_PATH)
+
+            # Construct the contentstore for storing the first import
+            with MongoContentstoreBuilder().build() as source_content:
+                # Construct the modulestore for storing the first import (using the previously created contentstore)
+                with source_ms.build(source_content) as source_store:
+                    source_course_key = source_store.make_course_key('a', 'course', 'course')
+                    asset_key = source_course_key.make_asset_key(
+                        AssetMetadata.GENERAL_ASSET_TYPE, 'silly_cat_picture.gif'
+                    )
+
+                    with CodeBlockTimer("initial_import"):
+                        import_from_xml(
+                            source_store,
+                            'test_user',
+                            TEST_DATA_ROOT,
+                            course_dirs=TEST_COURSE,
+                            static_content_store=source_content,
+                            target_course_id=source_course_key,
+                            create_course_if_not_present=True,
+                            raise_on_failure=True,
+                        )
+
+                    with CodeBlockTimer("find_nonexistent_asset"):
+                        # More correct would be using the AssetManager.find() - but since the test
+                        # has created its own test modulestore, the AssetManager can't be used.
+                        __ = source_store.find_asset_metadata(asset_key)
+
+                    # Perform get_all_asset_metadata for each sort.
+                    for sort in ALL_SORTS:
+                        with CodeBlockTimer("get_asset_list:{}-{}".format(
+                            sort[0],
+                            'asc' if sort[1] == ModuleStoreEnum.SortOrder.ascending else 'desc'
+                        )):
+                            # Grab two ranges of 50 assets using different sorts.
+                            # Why 50? That's how many are displayed on the current Studio "Files & Uploads" page.
+                            start_middle = num_assets / 2
+                            __ = source_store.get_all_asset_metadata(
+                                source_course_key, 'asset', start=0, sort=sort, maxresults=50
+                            )
+                            __ = source_store.get_all_asset_metadata(
+                                source_course_key, 'asset', start=start_middle, sort=sort, maxresults=50
+                            )