Changeset 14638

Timestamp:

Mar 25, 2016, 6:22:36 PM (10 years ago)

Author:

Ryan J Ollos

Message:

1.2dev: Merge [14637] from 1.0-stable

Refs #12410.

Location:

trunk

Files:

• . (modified) (1 prop)
• trac/admin/web_ui.py (modified) (3 diffs)
• trac/env.py (modified) (5 diffs)
• trac/loader.py (modified) (3 diffs)
• trac/tests/functional/testcases.py (modified) (7 diffs)
• trac/tests/functional/testenv.py (modified) (2 diffs)
• trac/ticket/tests/functional/main.py (modified) (3 diffs)
• trac/web/chrome.py (modified) (2 diffs)
• trac/wiki/tests/functional.py (modified) (1 diff)

trunk/trac/admin/web_ui.py

@@ -502 +502 @@
                               "egg"))
 
-        target_path = os.path.join(self.env.path, 'plugins', plugin_filename)
+        target_path = os.path.join(self.env.plugins_dir, plugin_filename)
         if os.path.isfile(target_path):
             raise TracError(_("Plugin %(name)s already installed",
@@ -528 +528 @@
         if not plugin_filename:
             return
-        plugin_path = os.path.join(self.env.path, 'plugins', plugin_filename)
+        plugin_path = os.path.join(self.env.plugins_dir, plugin_filename)
         if not os.path.isfile(plugin_path):
             return
@@ -599 +599 @@
         data = {
             'plugins': plugins, 'show': req.args.get('show'),
-            'readonly': not os.access(self.env.get_plugins_dir(),
+            'readonly': not os.access(self.env.plugins_dir,
                                       os.F_OK + os.W_OK),
             'safe_wiki_to_html': safe_wiki_to_html,

trunk/trac/env.py

@@ -557 +557 @@
         if not os.path.exists(self.path):
             os.mkdir(self.path)
-        os.mkdir(self.get_log_dir())
-        os.mkdir(self.get_htdocs_dir())
-        os.mkdir(os.path.join(self.path, 'plugins'))
+        os.mkdir(self.log_dir)
+        os.mkdir(self.htdocs_dir)
+        os.mkdir(self.plugins_dir)
 
         # Create a few files
@@ -568 +568 @@
 
         # Setup the default configuration
-        os.mkdir(os.path.join(self.path, 'conf'))
+        os.mkdir(self.conf_dir)
         create_file(self.config_file_path + '.sample')
         config = Configuration(self.config_file_path)
@@ -641 +641 @@
     def config_file_path(self):
         """Path of the trac.ini file."""
-        return os.path.join(self.path, 'conf', 'trac.ini')
+        return os.path.join(self.conf_dir, 'trac.ini')
 
     def _get_path_to_dir(self, dir):
@@ -647 +647 @@
         return os.path.normcase(os.path.realpath(path))
 
+    @lazy
+    def conf_dir(self):
+        """Absolute path to the conf directory.
+
+        :since: 1.0.11
+        """
+        return self._get_path_to_dir('conf')
+
+    @lazy
+    def htdocs_dir(self):
+        """Absolute path to the htdocs directory.
+
+        :since: 1.0.11
+        """
+        return self._get_path_to_dir('htdocs')
+
+    def get_htdocs_dir(self):
+        """Return absolute path to the htdocs directory.
+
+        :since 1.0.11: Deprecated and will be removed in 1.3.1. Use the
+                       `htdocs_dir` property instead.
+        """
+        return self._get_path_to_dir('htdocs')
+
+    @lazy
+    def log_dir(self):
+        """Absolute path to the log directory.
+
+        :since: 1.0.11
+        """
+        return self._get_path_to_dir('log')
+
+    def get_log_dir(self):
+        """Return absolute path to the log directory.
+
+        :since 1.0.11: Deprecated and will be removed in 1.3.1. Use the
+                       `log_dir` property instead.
+        """
+        return self._get_path_to_dir('log')
+
+    @lazy
+    def plugins_dir(self):
+        """Absolute path to the plugins directory.
+
+        :since: 1.0.11
+        """
+        return self._get_path_to_dir('plugins')
+
+    @lazy
+    def templates_dir(self):
+        """Absolute path to the templates directory.
+
+        :since: 1.0.11
+        """
+        return self._get_path_to_dir('templates')
+
     def get_templates_dir(self):
-        """Return absolute path to the templates directory."""
+        """Return absolute path to the templates directory.
+
+        :since 1.0.11: Deprecated and will be removed in 1.3.1. Use the
+                       `templates_dir` property instead.
+        """
         return self._get_path_to_dir('templates')
-
-    def get_htdocs_dir(self):
-        """Return absolute path to the htdocs directory."""
-        return self._get_path_to_dir('htdocs')
-
-    def get_log_dir(self):
-        """Return absolute path to the log directory."""
-        return self._get_path_to_dir('log')
-
-    def get_plugins_dir(self):
-        """Return absolute path to the plugins directory."""
-        return self._get_path_to_dir('plugins')
 
     def setup_log(self):
@@ -668 +716 @@
         logfile = self.log_file
         if logtype == 'file' and not os.path.isabs(logfile):
-            logfile = os.path.join(self.get_log_dir(), logfile)
+            logfile = os.path.join(self.log_dir, logfile)
         format = self.log_format
         logid = 'Trac.%s' % hashlib.sha1(self.path).hexdigest()

trunk/trac/loader.py

@@ -102 +102 @@
     """Return the path to the `plugins` directory of the environment.
 
-    :since 1.0.11: Deprecated and will be removed in 1.3.1. Use
-                   Environment.get_plugins_dir() instead."""
-    return env.get_plugins_dir()
+    :since 1.0.11: Deprecated and will be removed in 1.3.1. Use the
+                   Environment.plugins_dir property instead."""
+    return env.plugins_dir
 
 
@@ -110 +110 @@
                                                    load_py_files())):
     """Load all plugin components found on the given search path."""
-    plugins_dir = env.get_plugins_dir()
+    plugins_dir = env.plugins_dir
     search_path = [plugins_dir]
     if extra_path:
@@ -139 +139 @@
         return dist
 
-    plugins_dir = env.get_plugins_dir()
+    plugins_dir = env.plugins_dir
     plugins = {}
     from trac.core import ComponentMeta

trunk/trac/tests/functional/testcases.py

@@ -55 +55 @@
         env.config.set('components', 'RaiseExceptionPlugin.*', 'enabled')
         env.config.save()
-        create_file(os.path.join(env.path, 'plugins',
-                                 'RaiseExceptionPlugin.py'),
+        create_file(os.path.join(env.plugins_dir, 'RaiseExceptionPlugin.py'),
 """\
 from trac.core import Component, implements
@@ -99 +98 @@
         """Test for regression of the plugin reload fix in r6017"""
         # Setup the DeleteTicket plugin
+        env = self._testenv.get_trac_environment()
         plugin = open(os.path.join(self._testenv.trac_src,
                                    'sample-plugins', 'workflow',
                                    'DeleteTicket.py')).read()
-        open(os.path.join(self._testenv.tracdir, 'plugins',
-                          'DeleteTicket.py'), 'w').write(plugin)
-        env = self._testenv.get_trac_environment()
+        plugin_path = os.path.join(env.plugins_dir, 'DeleteTicket.py')
+        open(plugin_path, 'w').write(plugin)
         prevconfig = env.config.get('ticket', 'workflow')
         env.config.set('ticket', 'workflow',
@@ -123 +122 @@
             env.config.save()
             for ext in ('py', 'pyc', 'pyo'):
-                filename = os.path.join(self._testenv.tracdir, 'plugins',
+                filename = os.path.join(env.plugins_dir,
                                         'DeleteTicket.%s' % ext)
                 if os.path.exists(filename):
@@ -132 +131 @@
     def runTest(self):
         """Test for regression of http://trac.edgewall.org/ticket/3833 a"""
+        env = self._testenv.get_trac_environment()
         # Assume the logging is already set to debug.
-        traclogfile = open(os.path.join(self._testenv.tracdir, 'log',
-                                        'trac.log'))
+        traclogfile = open(os.path.join(env.log_dir, 'trac.log'))
         # Seek to the end of file so we only look at new log output
         traclogfile.seek(0, 2)
+
         # Verify that logging is on initially
-        env = self._testenv.get_trac_environment()
-
         env.log.debug("RegressionTestTicket3833 debug1")
         debug1 = traclogfile.read()
@@ -152 +150 @@
         # Turn logging off, try to log something, and verify that it does
         # not show up.
-        traclogfile = open(os.path.join(self._testenv.tracdir, 'log',
-                                        'trac.log'))
+        env = self._testenv.get_trac_environment()
+        traclogfile = open(os.path.join(env.log_dir, 'trac.log'))
         # Seek to the end of file so we only look at new log output
         traclogfile.seek(0, 2)
-        env = self._testenv.get_trac_environment()
 
         env.config.set('logging', 'log_level', 'INFO')
@@ -176 +173 @@
         # Turn logging back on, try to log something, and verify that it
         # does show up.
-        traclogfile = open(os.path.join(self._testenv.tracdir, 'log',
-                                        'trac.log'))
+        env = self._testenv.get_trac_environment()
+        traclogfile = open(os.path.join(env.log_dir, 'trac.log'))
         # Seek to the end of file so we only look at new log output
         traclogfile.seek(0, 2)
-        env = self._testenv.get_trac_environment()
 
         env.config.set('logging', 'log_level', 'DEBUG')
@@ -318 +314 @@
         env.config.set('components', 'RaiseExceptionPlugin.*', 'enabled')
         env.config.save()
-        create_file(os.path.join(env.path, 'plugins', 'RaiseExceptionPlugin.py'),
+        create_file(os.path.join(env.plugins_dir, 'RaiseExceptionPlugin.py'),
 """\
 from trac.core import Component, implements

trunk/trac/tests/functional/testenv.py

@@ -337 +337 @@
             filename = 'authz-' + \
                        hashlib.md5(str(authz_content)).hexdigest()[:9]
-        authz_file = os.path.join(self.tracdir, 'conf', filename)
+        env = self.get_trac_environment()
+        authz_file = os.path.join(env.conf_dir, filename)
         if os.path.exists(authz_file):
             wait_for_file_mtime_change(authz_file)
@@ -353 +354 @@
             with open(authz_file, 'w') as f:
                 parser.write(f)
-        env = self.get_trac_environment()
         permission_policies = env.config.get('trac', 'permission_policies')
         env.config.set('trac', 'permission_policies',

trunk/trac/ticket/tests/functional/main.py

@@ -143 +143 @@
         env.config.set('components', plugin_name + '.*', 'enabled')
         env.config.save()
-        create_file(os.path.join(env.path, 'plugins', plugin_name + '.py'),
+        create_file(os.path.join(env.plugins_dir, plugin_name + '.py'),
 """\
 from genshi.builder import tag
@@ -1257 +1257 @@
         plugin = open(os.path.join(self._testenv.trac_src, 'sample-plugins',
                                    'workflow', 'DeleteTicket.py')).read()
-        open(os.path.join(self._testenv.tracdir, 'plugins',
-                          'DeleteTicket.py'), 'w').write(plugin)
         env = self._testenv.get_trac_environment()
+        plugin_path = os.path.join(env.plugins_dir, 'DeleteTicket.py')
+        open(plugin_path, 'w').write(plugin)
         prevconfig = env.config.get('ticket', 'workflow')
         env.config.set('ticket', 'workflow',
@@ -1285 +1285 @@
         self._testenv.get_trac_environment()  # reload environment
         for ext in ('py', 'pyc', 'pyo'):
-            filename = os.path.join(self._testenv.tracdir, 'plugins',
-                                    'DeleteTicket.%s' % ext)
+            filename = os.path.join(env.plugins_dir, 'DeleteTicket.%s' % ext)
             if os.path.exists(filename):
                 os.unlink(filename)

trunk/trac/web/chrome.py

@@ -737 +737 @@
         return [('common', pkg_resources.resource_filename('trac', 'htdocs')),
                 ('shared', self.shared_htdocs_dir),
-                ('site', self.env.get_htdocs_dir())]
+                ('site', self.env.htdocs_dir)]
 
     def get_templates_dirs(self):
         return filter(None, [
-            self.env.get_templates_dir(),
+            self.env.templates_dir,
             self.shared_templates_dir,
             pkg_resources.resource_filename('trac', 'templates'),
@@ -1188 +1188 @@
         files = {}
         # Collect templates list
-        site_templates = list_dir(self.env.get_templates_dir(), '.html')
+        site_templates = list_dir(self.env.templates_dir, '.html')
         shared_templates = list_dir(Chrome(self.env).shared_templates_dir,
                                     '.html')
 
         # Collect static resources list
-        site_htdocs = list_dir(self.env.get_htdocs_dir())
+        site_htdocs = list_dir(self.env.htdocs_dir)
         shared_htdocs = list_dir(Chrome(self.env).shared_htdocs_dir)
 

trunk/trac/wiki/tests/functional.py

@@ -88 +88 @@
         env.config.set('components', plugin_name + '.*', 'enabled')
         env.config.save()
-        create_file(os.path.join(env.path, 'plugins',
-                                 plugin_name + '.py'), """\
+        create_file(os.path.join(env.plugins_dir, plugin_name + '.py'), """\
 from genshi.builder import tag
 from trac.core import Component, implements