Migrate configuration from "examples/" to "config/"

wil93 · stefano-maggiolo · commit 612b766591ce · 2015-01-02T14:37:34.000Z
diff --git a/cms/conf.py b/cms/conf.py
@@ -41,8 +41,8 @@
 class Config(object):
     """This class will contain the configuration for CMS. This needs
     to be populated at the initilization stage. This is loaded by
-    default with some sane data. See cms.conf.sample in the examples
-    for information on the meaning of the fields.
+    default with some sane data. See cms.conf.sample in the config
+    directory for information on the meaning of the fields.
 
     """
     def __init__(self):
@@ -134,11 +134,11 @@ def __init__(self):
             self.cache_dir = "cache"
             self.data_dir = "lib"
             self.run_dir = "run"
-            paths = [os.path.join(".", "examples", "cms.conf")]
+            paths = [os.path.join(".", "config", "cms.conf")]
             if '__file__' in globals():
                 paths += [os.path.abspath(os.path.join(
                           os.path.dirname(__file__),
-                          '..', 'examples', 'cms.conf'))]
+                          '..', 'config', 'cms.conf'))]
             paths += [os.path.join("/", "usr", "local", "etc", "cms.conf"),
                       os.path.join("/", "etc", "cms.conf")]
 
diff --git a/cmsranking/Config.py b/cmsranking/Config.py
@@ -70,7 +70,7 @@ def __init__(self):
         else:
             self.log_dir = os.path.join("log", "ranking")
             self.lib_dir = os.path.join("lib", "ranking")
-            paths = [os.path.join(".", "examples", "cms.ranking.conf"),
+            paths = [os.path.join(".", "config", "cms.ranking.conf"),
                      os.path.join("/", "usr", "local", "etc",
                                   "cms.ranking.conf"),
                      os.path.join("/", "etc", "cms.ranking.conf")]
diff --git a/cmstestsuite/RunFunctionalTests.py b/cmstestsuite/RunFunctionalTests.py
@@ -419,7 +419,7 @@ def main():
     except subprocess.CalledProcessError:
         git_root = None
     CONFIG["TEST_DIR"] = git_root
-    CONFIG["CONFIG_PATH"] = "%s/examples/cms.conf" % CONFIG["TEST_DIR"]
+    CONFIG["CONFIG_PATH"] = "%s/config/cms.conf" % CONFIG["TEST_DIR"]
     if CONFIG["TEST_DIR"] is None:
         CONFIG["CONFIG_PATH"] = "/usr/local/etc/cms.conf"
     cms_config = get_cms_config()
diff --git a/cmstestsuite/RunUnitTests.py b/cmstestsuite/RunUnitTests.py
@@ -183,7 +183,7 @@ def main():
 
     # Load config from cms.conf.
     CONFIG["TEST_DIR"] = git_root
-    CONFIG["CONFIG_PATH"] = "%s/examples/cms.conf" % CONFIG["TEST_DIR"]
+    CONFIG["CONFIG_PATH"] = "%s/config/cms.conf" % CONFIG["TEST_DIR"]
     if CONFIG["TEST_DIR"] is None:
         CONFIG["CONFIG_PATH"] = "/usr/local/etc/cms.conf"
 
diff --git a/cmstestsuite/TestCleanCheckout.py b/cmstestsuite/TestCleanCheckout.py
@@ -106,7 +106,7 @@ def setup_cms():
     args = parser.parse_args()
 
     CONFIG["TEST_DIR"] = tempfile.mkdtemp()
-    CONFIG["CONFIG_PATH"] = "%s/examples/cms.conf" % CONFIG["TEST_DIR"]
+    CONFIG["CONFIG_PATH"] = "%s/config/cms.conf" % CONFIG["TEST_DIR"]
     CONFIG["GIT_ORIGIN"] = subprocess.check_output(
         "git rev-parse --show-toplevel", shell=True).strip()
     if args.revision is None:
diff --git a/cmstestsuite/__init__.py b/cmstestsuite/__init__.py
@@ -5,6 +5,7 @@
 # Copyright © 2012 Bernard Blackham <bernard@largestprime.net>
 # Copyright © 2013 Stefano Maggiolo <s.maggiolo@gmail.com>
 # Copyright © 2013-2014 Luca Wehrstedt <luca.wehrstedt@gmail.com>
+# Copyright © 2014 William Di Luigi <williamdiluigi@gmail.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as
@@ -185,9 +186,10 @@ def configure_cms(options):
     options (dict): mapping from parameter to textual JSON argument.
 
     """
-    f = io.open("%(TEST_DIR)s/examples/cms.conf.sample" % CONFIG,
-                "rt", encoding="utf-8")
-    lines = f.readlines()
+    with io.open("%(TEST_DIR)s/config/cms.conf.sample" % CONFIG,
+                 "rt", encoding="utf-8") as in_f:
+        lines = in_f.readlines()
+
     unset = set(options.keys())
     for i, line in enumerate(lines):
         g = re.match(r'^(\s*)"([^"]+)":', line)
@@ -197,10 +199,9 @@ def configure_cms(options):
                 lines[i] = '%s"%s": %s,\n' % (whitespace, key, options[key])
                 unset.remove(key)
 
-    out_file = io.open("%(CONFIG_PATH)s" % CONFIG, "wt", encoding="utf-8")
-    for l in lines:
-        out_file.write(l)
-    out_file.close()
+    with io.open("%(CONFIG_PATH)s" % CONFIG, "wt", encoding="utf-8") as out_f:
+        for l in lines:
+            out_f.write(l)
 
     if unset:
         print("These configuration items were not set:")
diff --git a/config/.gitignore b/config/.gitignore
diff --git a/config/cms.conf.sample b/config/cms.conf.sample
diff --git a/config/cms.ranking.conf.sample b/config/cms.ranking.conf.sample
diff --git a/config/nginx.conf.sample b/config/nginx.conf.sample
diff --git a/docs/RankingWebServer.rst b/docs/RankingWebServer.rst
@@ -13,7 +13,7 @@ To start RWS you have to execute ``cmsRankingWebServer``.
 Configuring it
 --------------
 
-The configuration file is named :file:`cms.ranking.conf` and RWS will search for it in :file:`/usr/local/etc` and in :file:`/etc` (in this order!). In case it's not found in any of these, RWS will use a hard-coded default configuration that can be found in :gh_blob:`cmsranking/Config.py`. If RWS is not installed then the :gh_tree:`examples` directory will also be checked for configuration files (note that for this to work your working directory needs to be root of the repository). In any case, as soon as you start it, RWS will tell you which configuration file it's using.
+The configuration file is named :file:`cms.ranking.conf` and RWS will search for it in :file:`/usr/local/etc` and in :file:`/etc` (in this order!). In case it's not found in any of these, RWS will use a hard-coded default configuration that can be found in :gh_blob:`cmsranking/Config.py`. If RWS is not installed then the :gh_tree:`config` directory will also be checked for configuration files (note that for this to work your working directory needs to be root of the repository). In any case, as soon as you start it, RWS will tell you which configuration file it's using.
 
 The configuration file is a JSON object. The most important parameters are:
 
diff --git a/docs/Running CMS.rst b/docs/Running CMS.rst
@@ -40,7 +40,7 @@ Finally you have to create the database schema for CMS, by running:
 Configuring CMS
 ===============
 
-There are two configuration files, one for CMS itself and one for the rankings. Samples for both files are in the directory :gh_tree:`examples/`. You want to copy them to the same file names but without the ``.sample`` suffix (that is, to :file:`examples/cms.conf` and :file:`examples/cms.ranking.conf`) before modifying them.
+There are two configuration files, one for CMS itself and one for the rankings. Samples for both files are in the directory :gh_tree:`config/`. You want to copy them to the same file names but without the ``.sample`` suffix (that is, to :file:`config/cms.conf` and :file:`config/cms.ranking.conf`) before modifying them.
 
 * :file:`cms.conf` is intended to be the same on all servers; all configurations are explained in the file; of particular importance is the definition of ``core_services``, that specifies where the services are going to be run, and how many of them, and the connecting line for the database, in which you need to specify the name of the user created above and its password.
 
@@ -60,7 +60,7 @@ If you are organizing a real contest, you must change ``secret_key`` from the de
 
    As the name implies, the value of ``secret_key`` must be kept confidential. If a contestant knows it (for example because you are using the default value), they may be easily able to log in as another contestant.
 
-After having modified :file:`cms.conf` and :file:`cms.ranking.conf` in :gh_tree:`examples/`, you can reinstall CMS in order to make these changes effective, with
+After having modified :file:`cms.conf` and :file:`cms.ranking.conf` in :gh_tree:`config/`, you can reinstall CMS in order to make these changes effective, with
 
 .. sourcecode:: bash
 
@@ -108,7 +108,7 @@ As for the distribution of services, usually there is one ResourceService for ea
 
 We suggest and support out-of-the-box using CMS over Ubuntu 14.04. Yet, CMS can be successfully run on different Linux distributions. Non-Linux operating systems are not supported.
 
-You can replicate the service handling the contestant-facing web server, :file:`cmsContestWebServer`; in this case, you need to configure a load balancer in front of them. We suggest to use nginx for that, and provide a sample configuration for it at :gh_blob:`examples/nginx.conf.sample` (this file also configures nginx to act as a HTTPS endpoint and to force secure connections, by redirecting HTTP to HTTPS). This file probably needs to be adapted to your distribution if it's not Ubuntu: try to merge it with the file you find installed by default. For additional information see the official nginx `documentation <http://wiki.nginx.org/HttpUpstreamModule>`_ and `examples <http://wiki.nginx.org/LoadBalanceExample>`_. Note that without the ``ip_hash`` option some features might not always work as expected.
+You can replicate the service handling the contestant-facing web server, :file:`cmsContestWebServer`; in this case, you need to configure a load balancer in front of them. We suggest to use nginx for that, and provide a sample configuration for it at :gh_blob:`config/nginx.conf.sample` (this file also configures nginx to act as a HTTPS endpoint and to force secure connections, by redirecting HTTP to HTTPS). This file probably needs to be adapted to your distribution if it's not Ubuntu: try to merge it with the file you find installed by default. For additional information see the official nginx `documentation <http://wiki.nginx.org/HttpUpstreamModule>`_ and `examples <http://wiki.nginx.org/LoadBalanceExample>`_. Note that without the ``ip_hash`` option some features might not always work as expected.
 
 
 Logs
diff --git a/setup.py b/setup.py
@@ -292,12 +292,12 @@ def install():
         # Skip if destination is a symlink
         if os.path.islink(conf_file):
             continue
-        if os.path.exists(os.path.join(".", "examples", conf_file_name)):
-            copyfile(os.path.join(".", "examples", conf_file_name),
+        if os.path.exists(os.path.join(".", "config", conf_file_name)):
+            copyfile(os.path.join(".", "config", conf_file_name),
                      conf_file, cmsuser, 0660)
         else:
             conf_file_name = "%s.sample" % conf_file_name
-            copyfile(os.path.join(".", "examples", conf_file_name),
+            copyfile(os.path.join(".", "config", conf_file_name),
                      conf_file, cmsuser, 0660)
 
     print("copying localization files:")
