vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Merge pull request #13692 from resilient-tech/fix-boilerplate

Browse source 
fix: escape quotes before declaring variables when making a new app
This commit is contained in:
mergify[bot] 2021-07-13 14:21:24 +00:00 • committed by GitHub
commit e528c959e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
frappe/tests/test_boilerplate.py
View file

@ -20,7 +20,7 @@ class TestBoilerPlate(unittest.TestCase):
def test_create_app(self):
title = "Test App"
description = "Test app for unit testing"
description = "This app's description contains 'single quotes' and \"double quotes\"."
publisher = "Test Publisher"
email = "example@example.org"
icon = "" # empty -> default

23
frappe/utils/boilerplate.py
View file

@ -66,9 +66,6 @@ def make_boilerplate(dest, app_name):
with open(os.path.join(dest, hooks.app_name, ".gitignore"), "w") as f:
f.write(frappe.as_unicode(gitignore_template.format(app_name = hooks.app_name)))
with open(os.path.join(dest, hooks.app_name, "setup.py"), "w") as f:
f.write(frappe.as_unicode(setup_template.format(**hooks)))
with open(os.path.join(dest, hooks.app_name, "requirements.txt"), "w") as f:
f.write("# frappe -- https://github.com/frappe/frappe is installed via 'bench init'")
@ -82,6 +79,14 @@ def make_boilerplate(dest, app_name):
with open(os.path.join(dest, hooks.app_name, hooks.app_name, "modules.txt"), "w") as f:
f.write(frappe.as_unicode(hooks.app_title))
# These values could contain quotes and can break string declarations
# So escaping them before setting variables in setup.py and hooks.py
for key in ("app_publisher", "app_description", "app_license"):
hooks[key] = hooks[key].replace("\\", "\\\\").replace("'", "\\'").replace("\"", "\\\"")
with open(os.path.join(dest, hooks.app_name, "setup.py"), "w") as f:
f.write(frappe.as_unicode(setup_template.format(**hooks)))
with open(os.path.join(dest, hooks.app_name, hooks.app_name, "hooks.py"), "w") as f:
f.write(frappe.as_unicode(hooks_template.format(**hooks)))
@ -328,18 +333,18 @@ def get_data():
setup_template = """from setuptools import setup, find_packages
with open('requirements.txt') as f:
install_requires = f.read().strip().split('\\n')
with open("requirements.txt") as f:
install_requires = f.read().strip().split("\\n")
# get version from __version__ variable in {app_name}/__init__.py
from {app_name} import __version__ as version
setup(
name='{app_name}',
name="{app_name}",
version=version,
description='{app_description}',
author='{app_publisher}',
author_email='{app_email}',
description="{app_description}",
author="{app_publisher}",
author_email="{app_email}",
packages=find_packages(),
zip_safe=False,
include_package_data=True,