_yaml.config_dump() for writing out config

This outputs YAML in a string that is suitable for use in regexps
and string replacements, as well as complete files.  It is therefore
explicitly set up to avoid writing out headers and footers.
This commit is contained in:
Hans-Christoph Steiner 2025-03-07 17:30:46 +01:00
parent 2f47938dbf
commit 3ab2baf542
4 changed files with 35 additions and 14 deletions

View file

@ -31,7 +31,7 @@ import fdroidserver.common
import fdroidserver.metadata
from .shared_test_code import TmpCwd, mkdtemp
from fdroidserver.common import ANTIFEATURES_CONFIG_NAME, CATEGORIES_CONFIG_NAME
from fdroidserver._yaml import yaml, yaml_dumper
from fdroidserver._yaml import yaml, yaml_dumper, config_dump
from fdroidserver.exception import FDroidException, VCSException,\
MetaDataException, VerificationException
from fdroidserver.looseversion import LooseVersion
@ -1933,7 +1933,7 @@ class CommonTest(unittest.TestCase):
os.chdir(self.tmpdir)
teststr = '/πÇÇ现代通用字-български-عربي1/ö/yml'
with open(fdroidserver.common.CONFIG_FILE, 'w', encoding='utf-8') as fp:
yaml_dumper.dump({'apksigner': teststr}, fp)
config_dump({'apksigner': teststr}, fp)
self.assertTrue(os.path.exists(fdroidserver.common.CONFIG_FILE))
config = fdroidserver.common.read_config()
self.assertEqual(teststr, config.get('apksigner'))
@ -2633,7 +2633,7 @@ class CommonTest(unittest.TestCase):
' -providerClass sun.security.pkcs11.SunPKCS11'
' -providerArg opensc-fdroid.cfg'
}
yaml_dumper.dump(d, fp)
config_dump(d, fp)
config = fdroidserver.common.read_config()
fdroidserver.common.config = config
self.assertTrue(isinstance(d['smartcardoptions'], str))

View file

@ -12,7 +12,7 @@ from .shared_test_code import mkdtemp
import fdroidserver.common
import fdroidserver.lint
import fdroidserver.metadata
from fdroidserver._yaml import yaml_dumper
from fdroidserver._yaml import config_dump
basedir = Path(__file__).parent
@ -365,13 +365,13 @@ class LintTest(unittest.TestCase):
def test_lint_config_basic_mirrors_yml(self):
os.chdir(self.testdir)
with Path('mirrors.yml').open('w') as fp:
yaml_dumper.dump([{'url': 'https://example.com/fdroid/repo'}], fp)
config_dump([{'url': 'https://example.com/fdroid/repo'}], fp)
self.assertTrue(fdroidserver.lint.lint_config('mirrors.yml'))
def test_lint_config_mirrors_yml_kenya_countryCode(self):
os.chdir(self.testdir)
with Path('mirrors.yml').open('w') as fp:
yaml_dumper.dump(
config_dump(
[{'url': 'https://foo.com/fdroid/repo', 'countryCode': 'KE'}], fp
)
self.assertTrue(fdroidserver.lint.lint_config('mirrors.yml'))
@ -380,7 +380,7 @@ class LintTest(unittest.TestCase):
"""WV is "indeterminately reserved" so it should never be used."""
os.chdir(self.testdir)
with Path('mirrors.yml').open('w') as fp:
yaml_dumper.dump(
config_dump(
[{'url': 'https://foo.com/fdroid/repo', 'countryCode': 'WV'}], fp
)
self.assertFalse(fdroidserver.lint.lint_config('mirrors.yml'))
@ -389,7 +389,7 @@ class LintTest(unittest.TestCase):
"""Only ISO 3166-1 alpha 2 are supported"""
os.chdir(self.testdir)
with Path('mirrors.yml').open('w') as fp:
yaml_dumper.dump(
config_dump(
[{'url': 'https://de.com/fdroid/repo', 'countryCode': 'DEU'}], fp
)
self.assertFalse(fdroidserver.lint.lint_config('mirrors.yml'))
@ -398,7 +398,7 @@ class LintTest(unittest.TestCase):
"""WV is "indeterminately reserved" so it should never be used."""
os.chdir(self.testdir)
with Path('mirrors.yml').open('w') as fp:
yaml_dumper.dump(
config_dump(
[
{'url': 'https://bar.com/fdroid/repo', 'countryCode': 'BA'},
{'url': 'https://foo.com/fdroid/repo', 'countryCode': 'FO'},