Fix #499: allow license.md/changelog.md/readme.md files

Author: rubidium42

bananas_api/new_upload/session_validation.py

@@ -31,15 +31,16 @@ def validate_license(session):
         session["errors"].append("License is not yet set for this package.")
     elif session["license"] == License.CUSTOM:
         for file_info in session["files"]:
-            if file_info["filename"] == "license.txt":
+            if file_info["filename"] in ("license.txt", "license.md"):
                 break
         else:
-            session["errors"].append("License is set to custom, but no license.txt is uploaded.")
+            session["errors"].append("License is set to custom, but no 'license.txt' or 'license.md' is uploaded.")
     else:
         for file_info in session["files"]:
-            if file_info["filename"] == "license.txt":
+            if file_info["filename"] in ("license.txt", "license.md"):
                 session["errors"].append(
-                    f"License is set to {session['license'].value}; this does not require uploading 'license.txt'."
+                    f"License is set to {session['license'].value}; "
+                    "this does not require uploading 'license.txt' or 'license.md'."
                 )
 
 

bananas_api/new_upload/validate.py

@@ -97,9 +97,9 @@
 
 # readme.txt and changelog.txt can have translations. This can be with the
 # first part of the ISO code, or with the full. For example:
-# readme.txt, readme_nl.txt, readme_nl_NL.txt
+# readme.txt, readme_nl.txt, readme_nl_NL.txt, readme.md
 # All other variantions are not valid.
-txt_regexp = re.compile(r"(readme|changelog)(_[a-z]{2}(_[A-Z]{2})?)?\.txt$")
+txt_regexp = re.compile(r"(readme|changelog)(_[a-z]{2}(_[A-Z]{2})?)?\.(txt|md)$")
 
 
 def _validate_textfile_encoding(fp):
@@ -111,14 +111,14 @@ def _validate_textfile_encoding(fp):
 
 def _read_object(filename, fp):
     lfilename = filename.lower()
-    if lfilename.endswith(".txt"):
-        if filename == "license.txt":
-            _validate_textfile_encoding(fp)
-            return None
-        elif txt_regexp.match(filename):
-            _validate_textfile_encoding(fp)
-            return None
-        elif filename.startswith("lang/"):
+    if filename in ("license.txt", "license.md"):
+        _validate_textfile_encoding(fp)
+        return None
+    elif txt_regexp.match(filename):
+        _validate_textfile_encoding(fp)
+        return None
+    elif lfilename.endswith(".txt"):
+        if filename.startswith("lang/"):
             _validate_textfile_encoding(fp)
             return None
         else:

regression/100_success_base_sounds.yaml

@@ -4,10 +4,11 @@ steps:
 - file-upload: nosound.obs
 - file-upload: nosound.cat
 - file-upload: license.txt
+  name: license.md
 - file-upload: readme.txt
-  name: readme_nl.txt
+  name: readme_nl.md
 - file-upload: changelog.txt
-  name: changelog_nl.txt
+  name: changelog_nl.md
 - api: new-package/update
   name: "test"
   version: "v1"

regression/921_missing_custom_license.yaml

@@ -6,4 +6,4 @@ steps:
   version: "test"
   license: "Custom"
 - api: new-package/publish
-  error: "License is set to custom, but no license.txt is uploaded."
+  error: "License is set to custom, but no 'license.txt' or 'license.md' is uploaded."

regression/923_custom_and_defined_license.yaml

@@ -7,4 +7,4 @@ steps:
   version: "test"
   license: "GPL v2"
 - api: new-package/publish
-  error: "License is set to GPL v2; this does not require uploading 'license.txt'."
+  error: "License is set to GPL v2; this does not require uploading 'license.txt' or 'license.md'."