Move base_dir to user_story_set, remove file_path.

BUG=454531

Review URL: https://codereview.chromium.org/946473002

Cr-Commit-Position: refs/heads/master@{#317632}

tools/telemetry/telemetry/page/page_set.py

@@ -24,19 +24,15 @@ class PageSet(user_story_set.UserStorySet):
                serving_dirs=None, bucket=None):
     # The default value of file_path is location of the file that define this
     # page set instance's class.
-    # TODO(chrishenry): Move this logic to user_story_set. Consider passing
-    # a base_dir directly. Alternatively, kill this and rely on the default
-    # behavior of using the instance's class file location.
-    if file_path is None:
-      file_path = inspect.getfile(self.__class__)
-      # Turn pyc file into py files if we can
-      if file_path.endswith('.pyc') and os.path.exists(file_path[:-1]):
-        file_path = file_path[:-1]
-    self.file_path = file_path
+    # TODO(aiolos): When migrating page_set's over to user_story_set's, make
+    # sure that we are passing a directory, not a file.
+    dir_name = file_path
+    if file_path and os.path.isfile(file_path):
+      dir_name = os.path.dirname(file_path)
 
     super(PageSet, self).__init__(
         archive_data_file=archive_data_file, cloud_storage_bucket=bucket,
-        serving_dirs=serving_dirs)
+        base_dir=dir_name, serving_dirs=serving_dirs)
 
     # These attributes can be set dynamically by the page set.
     self.user_agent_type = user_agent_type
@@ -50,13 +46,6 @@ class PageSet(user_story_set.UserStorySet):
     assert user_story.page_set is self
     super(PageSet, self).AddUserStory(user_story)
 
-  @property
-  def base_dir(self):
-    if os.path.isfile(self.file_path):
-      return os.path.dirname(self.file_path)
-    else:
-      return self.file_path
-
   def ReorderPageSet(self, results_file):
     """Reorders this page set based on the results of a past run."""
     page_set_dict = {}

tools/telemetry/telemetry/page/page_unittest.py

@@ -2,6 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import inspect
 import os
 import unittest
 
@@ -52,9 +53,11 @@ class TestPage(unittest.TestCase):
                       pages)
 
   def testGetUrlBaseDirAndFileForUrlBaseDir(self):
-    ps = page_set.PageSet(file_path='basedir/', serving_dirs=['../somedir/'])
+    base_dir = os.path.dirname(__file__)
+    file_path = os.path.dirname(base_dir) + '/otherdir/file.html'
+    ps = page_set.PageSet(file_path=base_dir, serving_dirs=['../somedir/'])
     ps.AddUserStory(page.Page('file://../otherdir/file.html', ps, ps.base_dir))
-    self.assertPathEqual(ps[0].file_path, 'otherdir/file.html')
+    self.assertPathEqual(ps[0].file_path, file_path)
 
   def testDisplayUrlForHttp(self):
     ps = page_set.PageSet(file_path=os.path.dirname(__file__))

tools/telemetry/telemetry/unittest_util/page_set_smoke_test.py

@@ -86,10 +86,10 @@ class PageSetSmokeTest(unittest.TestCase):
                        page, page_set.file_path)))
 
   def CheckAttributesOfPageSetBasicAttributes(self, page_set):
-    if page_set.file_path is not None:
+    if page_set.base_dir is not None:
       self.assertTrue(
-          isinstance(page_set.file_path, str),
-          msg='page_set %\'s file_path must have type string')
+          isinstance(page_set.base_dir, str),
+          msg='page_set %\'s base_dir must have type string')
 
     self.assertTrue(
         isinstance(page_set.archive_data_file, str),

tools/telemetry/telemetry/user_story/user_story_set.py

@@ -17,7 +17,7 @@ class UserStorySet(object):
   """
 
   def __init__(self, archive_data_file='', cloud_storage_bucket=None,
-               serving_dirs=None):
+               base_dir=None, serving_dirs=None):
     """Creates a new UserStorySet.
 
     Args:
@@ -33,11 +33,21 @@ class UserStorySet(object):
     self._wpr_archive_info = None
     archive_info.AssertValidCloudStorageBucket(cloud_storage_bucket)
     self._cloud_storage_bucket = cloud_storage_bucket
-    self._base_dir = os.path.dirname(inspect.getfile(self.__class__))
+    if base_dir:
+      if not os.path.isdir(base_dir):
+        raise ValueError('Must provide valid directory path for base_dir.')
+      self._base_dir = base_dir
+    else:
+      self._base_dir = os.path.dirname(inspect.getfile(self.__class__))
     # Convert any relative serving_dirs to absolute paths.
     self._serving_dirs = set(os.path.realpath(os.path.join(self.base_dir, d))
                              for d in serving_dirs or [])
 
+
+  @property
+  def file_path(self):
+    return inspect.getfile(self.__class__).replace('.pyc', '.py')
+
   @property
   def base_dir(self):
     """The base directory to resolve archive_data_file.

tools/telemetry/telemetry/user_story/user_story_set_unittest.py

@@ -2,6 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import inspect
 import os
 import unittest
 
@@ -14,6 +15,11 @@ class UserStorySetFoo(user_story_set.UserStorySet):
   pass
 
 
+class MockUserStorySet(user_story_set.UserStorySet):
+  def __init__(self):
+    super(MockUserStorySet, self).__init__()
+
+
 class UserStorySetTest(unittest.TestCase):
 
   def testUserStoryTestName(self):
@@ -30,6 +36,11 @@ class UserStorySetTest(unittest.TestCase):
     self.assertTrue(os.path.isdir(base_dir))
     self.assertEqual(base_dir, os.path.dirname(__file__))
 
+  def testFilePath(self):
+      uss = MockUserStorySet()
+      self.assertEqual(os.path.abspath(__file__),
+                       uss.file_path)
+
   def testCloudBucket(self):
     blank_uss = user_story_set.UserStorySet()
     self.assertEqual(blank_uss.bucket, None)