tests/metadata.TestCase

   1 #!/usr/bin/env python3
   2
   3 # http://www.drdobbs.com/testing/unit-testing-with-python/240165163
   4
   5 import glob
   6 import inspect
   7 import logging
   8 import optparse
   9 import os
  10 import random
  11 import shutil
  12 import sys
  13 import unittest
  14 import yaml
  15 import tempfile
  16
  17 localmodule = os.path.realpath(
  18     os.path.join(os.path.dirname(inspect.getfile(inspect.currentframe())), '..'))
  19 print('localmodule: ' + localmodule)
  20 if localmodule not in sys.path:
  21     sys.path.insert(0, localmodule)
  22
  23 import fdroidserver.common
  24 import fdroidserver.metadata
  25
  26
  27 class MetadataTest(unittest.TestCase):
  28     '''fdroidserver/metadata.py'''
  29
  30     def setUp(self):
  31         logging.basicConfig(level=logging.DEBUG)
  32         self.basedir = os.path.join(localmodule, 'tests')
  33         self.tmpdir = os.path.abspath(os.path.join(self.basedir, '..', '.testfiles'))
  34         if not os.path.exists(self.tmpdir):
  35             os.makedirs(self.tmpdir)
  36         os.chdir(self.basedir)
  37
  38     def test_read_metadata(self):
  39
  40         def _build_yaml_representer(dumper, data):
  41             '''Creates a YAML representation of a Build instance'''
  42             return dumper.represent_dict(data)
  43
  44         self.maxDiff = None
  45
  46         # these need to be set to prevent code running on None, only
  47         # 'accepted_formats' is actually used in metadata.py
  48         config = dict()
  49         config['sdk_path'] = '/opt/android-sdk'
  50         config['ndk_paths'] = dict()
  51         config['accepted_formats'] = ['json', 'txt', 'yml']
  52         fdroidserver.common.config = config
  53
  54         apps = fdroidserver.metadata.read_metadata(xref=True)
  55         for appid in ('org.smssecure.smssecure', 'org.adaway',
  56                       'org.videolan.vlc', 'com.politedroid'):
  57             savepath = os.path.join('metadata', 'dump', appid + '.yaml')
  58             frommeta = dict(apps[appid])
  59             self.assertTrue(appid in apps)
  60             with open(savepath, 'r') as f:
  61                 frompickle = yaml.load(f)
  62             self.assertEqual(frommeta, frompickle)
  63             # comment above assert and uncomment below to update test
  64             # files when new metadata fields are added
  65             # with open(savepath, 'w') as f:
  66             #     yaml.add_representer(fdroidserver.metadata.Build, _build_yaml_representer)
  67             #     yaml.dump(frommeta, f, default_flow_style=False)
  68
  69     def test_rewrite_yaml_fakeotaupdate(self):
  70         testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
  71         fdroidserver.common.config = {'accepted_formats': ['txt', 'yml']}
  72
  73         # rewrite metadata
  74         allapps = fdroidserver.metadata.read_metadata(xref=True)
  75         for appid, app in allapps.items():
  76             if appid == 'fake.ota.update':
  77                 fdroidserver.metadata.write_metadata(os.path.join(testdir, appid + '.yml'), app)
  78
  79         # assert rewrite result
  80         with open(os.path.join(testdir, 'fake.ota.update.yml'), 'r', encoding='utf-8') as result:
  81             with open('metadata-rewrite-yml/fake.ota.update.yml', 'r', encoding='utf-8') as orig:
  82                 self.maxDiff = None
  83                 self.assertEqual(result.read(), orig.read())
  84
  85     def test_rewrite_yaml_fdroidclient(self):
  86         testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
  87         fdroidserver.common.config = {'accepted_formats': ['txt', 'yml']}
  88
  89         # rewrite metadata
  90         allapps = fdroidserver.metadata.read_metadata(xref=True)
  91         for appid, app in allapps.items():
  92             if appid == 'org.fdroid.fdroid':
  93                 fdroidserver.metadata.write_metadata(os.path.join(testdir, appid + '.yml'), app)
  94
  95         # assert rewrite result
  96         with open(os.path.join(testdir, 'org.fdroid.fdroid.yml'), 'r', encoding='utf-8') as result:
  97             with open('metadata-rewrite-yml/org.fdroid.fdroid.yml', 'r', encoding='utf-8') as orig:
  98                 self.maxDiff = None
  99                 self.assertEqual(result.read(), orig.read())
 100
 101     def test_rewrite_yaml_special_build_params(self):
 102         testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
 103         fdroidserver.common.config = {'accepted_formats': ['txt', 'yml']}
 104
 105         # rewrite metadata
 106         allapps = fdroidserver.metadata.read_metadata(xref=True)
 107         for appid, app in allapps.items():
 108             if appid == 'app.with.special.build.params':
 109                 fdroidserver.metadata.write_metadata(os.path.join(testdir, appid + '.yml'), app)
 110
 111         # assert rewrite result
 112         with open(os.path.join(testdir, 'app.with.special.build.params.yml'), 'r', encoding='utf-8') as result:
 113             with open('metadata-rewrite-yml/app.with.special.build.params.yml', 'r', encoding='utf-8') as orig:
 114                 self.maxDiff = None
 115                 self.assertEqual(result.read(), orig.read())
 116
 117     def test_read_metadata_sort_by_time(self):
 118         testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
 119         metadatadir = os.path.join(testdir, 'metadata')
 120         os.makedirs(metadatadir)
 121         fdroidserver.common.config = {'accepted_formats': ['txt']}
 122
 123         randomlist = []
 124         randomapps = glob.glob(os.path.join(self.basedir, 'metadata', '*.txt'))
 125         random.shuffle(randomapps)
 126         i = 1
 127         for f in randomapps:
 128             shutil.copy(f, metadatadir)
 129             new = os.path.join(metadatadir, os.path.basename(f))
 130             stat = os.stat(new)
 131             os.utime(new, (stat.st_ctime, stat.st_mtime + i))
 132             # prepend new item so newest is always first
 133             randomlist = [os.path.basename(f)[:-4]] + randomlist
 134             i += 1
 135         os.chdir(testdir)
 136         allapps = fdroidserver.metadata.read_metadata(xref=True, sort_by_time=True)
 137         allappids = []
 138         for appid, app in allapps.items():
 139             allappids.append(appid)
 140         self.assertEqual(randomlist, allappids)
 141
 142
 143 if __name__ == "__main__":
 144     parser = optparse.OptionParser()
 145     parser.add_option("-v", "--verbose", action="store_true", default=False,
 146                       help="Spew out even more information than normal")
 147     (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
 148
 149     newSuite = unittest.TestSuite()
 150     newSuite.addTest(unittest.makeSuite(MetadataTest))
 151     unittest.main(failfast=False)