contest.yaml: Rename key testsession to test_session

Author: mpsijm

bin/export.py

@@ -560,7 +560,7 @@ def update_problems_yaml(problems: list[Problem], colors: Optional[list[str]] =
         if data != sorted_data:
             change = True
             data = sorted_data
-            label = "X" if contest_yaml().get("testsession") else "A"
+            label = "X" if contest_yaml().get("test_session") else "A"
             for d in data:
                 d["label"] = label
                 label = inc_label(label)

bin/latex.py

@@ -459,13 +459,13 @@ def build_contest_pdf(
         "subtitle": "",
         "year": "YEAR",
         "author": "AUTHOR",
-        "testsession": "",
+        "test_session": "",
     }
     config_data = contest_yaml()
     for x in default_config_data:
         if x not in config_data:
             config_data[x] = default_config_data[x]
-    config_data["testsession"] = "\\testsession" if config_data.get("testsession") else ""
+    config_data["test_session"] = "\\testsession" if config_data.get("test_session") else ""
     config_data["logofile"] = find_logo().as_posix()
 
     local_contest_data = Path("contest_data.tex")

bin/skel.py

@@ -36,7 +36,7 @@ def new_contest() -> None:
     subtitle = ask_variable_string("subtitle", "", True).replace("_", "-")
     dirname = ask_variable_string("dirname", _alpha_num(title))
     author = ask_variable_string("author", f"The {title} Jury").replace("_", "-")
-    testsession = ask_variable_bool("testsession", False)
+    test_session = ask_variable_bool("test session", False)
     year = ask_variable_string("year", str(datetime.datetime.now().year))
     source_url = ask_variable_string("source url", "", True)
     license = ask_variable_choice("license", config.KNOWN_LICENSES)
@@ -165,7 +165,7 @@ def new_problem() -> None:
             data = read_yaml(problems_yaml) or []
             prev_label = data[-1]["label"] if data else None
             next_label = (
-                ("X" if contest.contest_yaml().get("testsession") else "A")
+                ("X" if contest.contest_yaml().get("test_session") else "A")
                 if prev_label is None
                 else inc_label(prev_label)
             )

bin/tools.py

@@ -137,7 +137,9 @@ def parse_problems_yaml(problemlist):
 
     def fallback_problems():
         problem_paths = list(filter(is_problem_directory, glob(Path("."), "*/")))
-        label = chr(ord("Z") - len(problem_paths) + 1) if contest_yaml().get("testsession") else "A"
+        label = (
+            chr(ord("Z") - len(problem_paths) + 1) if contest_yaml().get("test_session") else "A"
+        )
         problems = []
         for path in problem_paths:
             problems.append((path, label))

bin/upgrade.py

@@ -71,6 +71,14 @@ def movetree(src: Path, dst: Path) -> None:
     movetree(src_base, dst_base)
 
 
+def upgrade_contest_yaml(contest_yaml_path: Path, bar: ProgressBar) -> None:
+    yaml_data = read_yaml(contest_yaml_path)
+    if "testsession" in yaml_data:
+        ryaml_replace(yaml_data, "testsession", "test_session")
+        write_yaml(yaml_data, contest_yaml_path)
+        bar.log("renaming 'testsession' to 'test_session'")
+
+
 def upgrade_data(problem_path: Path, bar: ProgressBar) -> None:
     rename = [
         ("data/invalid_inputs", "data/invalid_input"),
@@ -514,7 +522,14 @@ def is_problem_directory(path: Path) -> bool:
     else:
         paths = [p for p in cwd.iterdir() if is_problem_directory(p)]
 
-    bar = ProgressBar("upgrade", items=paths)
+    bar = ProgressBar("upgrade", items=["contest.yaml", *paths])
+
+    bar.start("contest.yaml")
+    if (cwd / "contest.yaml").is_file():
+        upgrade_contest_yaml(cwd / "contest.yaml", bar)
+    bar.done()
+
     for path in paths:
         _upgrade(path, bar)
+
     bar.finalize()

doc/commands.md

@@ -347,15 +347,14 @@ Settings for this contest will be asked for interactively. The following files a
 ```
 /tmp/tmp % bt new_contest
 name: NWERC 2020
-subtitle []: The Northwestern European Programming Contest 2020
-dirname [nwerc2020]:
-author [The NWERC 2020 jury]:
-testsession? [n (y/n)]: n
-year [2020]:
-source [NWERC 2020]:
-source url []: 2020.nwerc.eu
-license [cc by-sa]:
-rights owner [author]:
+subtitle: The Northwestern European Programming Contest 2020
+dirname (nwerc2020):
+author (The NWERC 2020 jury):
+test session? (y/N): n
+year (2020):
+source url: 2020.nwerc.eu
+license (cc by-sa):
+rights owner (if left empty, defaults to problem author):
 ```
 
 ## `new_problem`
@@ -365,9 +364,13 @@ Create a new problem directory and fill it with skel files. If `problems.yaml` i
 ```
 ~nwerc2020 % bt new_problem
 problem name (en): Test Problem
-dirname [testproblem]:
+dirname (testproblem):
 author: Ragnar Groot Koerkamp
-validation (default/custom/custom interactive) [default]:
+type (pass-fail):
+source (NWERC 2020):
+source url (2020.nwerc.eu):
+license (cc by-sa):
+rights owner (if left empty, defaults to problem author):
 LOG: Copying /home/philae/git/bapc/BAPCtools/skel/problem to testproblem.
 ```
 
@@ -629,7 +632,7 @@ This file should contain a list of problems, with for every problem the keys `id
 
 - `--colors`: Apply the given list of colors to the list of problems, in the same order as in `problems.yaml`.
   Should be a comma-separated list of colors (hash-sign is optional), e.g.: `--colors ff0000,00ff00,0000ff`.
-- `--sort`: Sort the problems in `problems.yaml` and re-label them starting from `A` (or `X` if `contest.yaml` contains `testsession: True`).
+- `--sort`: Sort the problems in `problems.yaml` and re-label them starting from `A` (or `X` if `contest.yaml` contains `test_session: True`).
 
 ## `tmp`
 

doc/implementation_notes.md

@@ -154,7 +154,7 @@ The following placeholders are automatically substituted in the `contest_data.te
 {%subtitle%}
 {%year%}
 {%author%}
-{%testsession%}
+{%test_session%}
 {%logofile%}
 ...
 <any entry in the contest.yaml>

latex/contest-web.tex

@@ -62,7 +62,7 @@
 \input{./contest-problems.tex}
 \makeatletter
 
-% An empty page at the end for non-testsession.
+% An empty page at the end if the contest is not a test session.
 \if\@testsession0
 	\clearpage
 	\pagestyle{empty}

latex/contest.tex

@@ -62,7 +62,7 @@
 \input{./contest-problems.tex}
 \makeatletter
 
-% An empty page at the end for non-testsession.
+% An empty page at the end if the contest is not a test session.
 \if\@testsession0
 	\clearpage
 	\pagestyle{empty}

latex/contest_data.tex

@@ -3,4 +3,4 @@
 \copyrightyear{{%year%}}
 \author{{%author%}}
 \newcommand{\logofile}{{%logofile%}}
-{%testsession%}
+{%test_session%}