test.py 12.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
##############################################################################
#
# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

import os
import subprocess
import json
import glob
import re

34 35
from six.moves.urllib.parse import urlparse

36
from slapos.recipe.librecipe import generateHashFromFiles
37
from slapos.testing.testcase import makeModuleSetUpAndTestCaseClass
38 39


40 41 42
setUpModule, InstanceTestCase = makeModuleSetUpAndTestCaseClass(
    os.path.abspath(
        os.path.join(os.path.dirname(__file__), '..', 'software.cfg')))
43 44


45 46 47 48 49 50 51 52
class NextCloudTestCase(InstanceTestCase):

  # calculated in setUp
  partition_dir = None
  nextcloud_path = None

  def setUp(self):
    # we want full diff when assertions fail
53
    self.maxDiff = None
54 55 56 57 58 59 60 61

    # lookup the partition in which nextcloud was installed
    partition_path_list = glob.glob(os.path.join(
        self.slap.instance_directory, '*'))
    for partition_path in partition_path_list:
      path = os.path.join(partition_path, 'srv/www')
      if os.path.exists(path):
        self.nextcloud_path = path
62
        self.partition_dir = partition_path
63 64 65 66 67
        break
    self.assertTrue(
        self.nextcloud_path,
        "Nextcloud path not found in %r" % (partition_path_list,))

68 69 70 71
    # parse database info from mariadb url
    d = self.computer_partition.getConnectionParameterDict()
    db_url = d['mariadb-url-list'][2:-2] # parse <url> out of "['<url>']"
    self._db_info = urlparse(db_url)
72 73

  def getNextcloudConfig(self, config_dict={}):
74 75
    data_dict = dict(
      datadirectory=self.partition_dir + "/srv/data",
76 77
      dbhost="%s:2099" % self._ipv4_address,
      dbname="nextcloud",
78
      dbpassword=self._db_info.password,
79 80 81 82 83 84 85 86 87 88
      dbport="",
      dbuser="nextcloud",
      mail_domain="nextcloud@example.com",
      mail_from_address="Nextcloud",
      mail_smtpauth=1,
      mail_smtpauthtype="LOGIN",
      mail_smtphost="",
      mail_smtpport="587",
      mail_smtppassword="",
      mail_smtpname="",
89
      cli_url="https://[%s]:9988/" % self._ipv6_address,
90
      partition_dir=self.partition_dir,
91
      trusted_domain_list=json.dumps(["[%s]:9988" % self._ipv6_address]),
92 93 94 95 96
      trusted_proxy_list=[],
    )
    data_dict.update(config_dict)

    template = """{
97 98
  "activity_expire_days": 14,
  "auth.bruteforce.protection.enabled": true,
99
  "blacklisted_files": [
100 101
    ".htaccess",
    "Thumbs.db",
102
    "thumbs.db"
103 104
  ],
  "cron_log": true,
105 106 107 108 109
  "csrf.optout": [
	  "/^WebDAVFS/",
	  "/^Microsoft-WebDAV-MiniRedir/",
	  "/^\\\\.jio_documents/"
	],
110 111 112 113 114 115 116 117 118
  "datadirectory": "%(datadirectory)s",
  "dbhost": "%(dbhost)s",
  "dbname": "%(dbname)s",
  "dbpassword": "%(dbpassword)s",
  "dbport": "",
  "dbtableprefix": "oc_",
  "dbtype": "mysql",
  "dbuser": "%(dbuser)s",
  "enable_previews": true,
119 120 121 122 123 124 125 126 127 128 129 130
  "enabledPreviewProviders": [
	  "OC\\\\Preview\\\\PNG",
	  "OC\\\\Preview\\\\JPEG",
	  "OC\\\\Preview\\\\GIF",
	  "OC\\\\Preview\\\\BMP",
	  "OC\\\\Preview\\\\XBitmap",
	  "OC\\\\Preview\\\\Movie",
	  "OC\\\\Preview\\\\PDF",
	  "OC\\\\Preview\\\\MP3",
	  "OC\\\\Preview\\\\TXT",
	  "OC\\\\Preview\\\\MarkDown"
	],
131 132
  "filelocking.enabled": "true",
  "filesystem_check_changes": 0,
133 134
  "forwarded_for_headers": [
    "HTTP_X_FORWARDED"
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
  ],
  "htaccess.RewriteBase": "/",
  "installed": true,
  "integrity.check.disabled": false,
  "knowledgebaseenabled": false,
  "log_rotate_size": 104857600,
  "logfile": "%(datadirectory)s/nextcloud.log",
  "loglevel": 2,
  "mail_domain": "%(mail_domain)s",
  "mail_from_address": "%(mail_from_address)s",
  "mail_sendmailmode": "smtp",
  "mail_smtpauth": %(mail_smtpauth)s,
  "mail_smtpauthtype": "%(mail_smtpauthtype)s",
  "mail_smtphost": "%(mail_smtphost)s",
  "mail_smtpmode": "smtp",
  "mail_smtpname": "%(mail_smtpname)s",
  "mail_smtppassword": "%(mail_smtppassword)s",
  "mail_smtpport": "%(mail_smtpport)s",
  "mail_smtpsecure": "tls",
  "maintenance": false,
155 156 157
  "memcache.locking": "\\\\OC\\\\Memcache\\\\Redis",
  "memcache.local": "\\\\OC\\\\Memcache\\\\APCu",
  "memcache.distributed": "\\\\OC\\\\Memcache\\\\Redis",
158 159 160 161 162 163 164
  "mysql.utf8mb4": true,
  "overwrite.cli.url": "%(cli_url)s",
  "overwriteprotocol": "https",
  "preview_max_scale_factor": 1,
  "preview_max_x": 1024,
  "preview_max_y": 768,
  "quota_include_external_storage": false,
165
  "redis": {
166 167
    "host": "%(partition_dir)s/srv/redis/redis.socket",
    "port": 0,
168
    "timeout": 0
169 170 171 172 173 174 175
  },
  "share_folder": "/Shares",
  "skeletondirectory": "",
  "theme": "",
  "trashbin_retention_obligation": "auto, 7",
  "trusted_domains": %(trusted_domain_list)s,
  "trusted_proxies": %(trusted_proxy_list)s,
176 177 178 179 180 181
  "updater.release.channel": "stable"
}"""

    return json.loads(template % data_dict)


182
class TestServices(NextCloudTestCase):
183
  __partition_reference__ = 'ncs'
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

  def test_process_list(self):
    hash_list = [
      'software_release/buildout.cfg',
    ]
    expected_process_names = [
      'bootstrap-monitor',
      'mariadb',
      'mariadb_update',
      'apache-php-{hash}-on-watch',
      'certificate_authority-{hash}-on-watch',
      'crond-{hash}-on-watch',
      'monitor-httpd-{hash}-on-watch',
      'monitor-httpd-graceful',
      'nextcloud-install',
      'nextcloud-news-updater',
      'redis-on-watch',
    ]

203 204
    with self.slap.instance_supervisor_rpc as supervisor:
      process_name_list = [process['name']
205 206 207 208 209 210
                     for process in supervisor.getAllProcessInfo()]

    hash_file_list = [os.path.join(self.computer_partition_root_path, path)
                      for path in hash_list]

    for name in expected_process_names:
211
      h = generateHashFromFiles(hash_file_list)
212 213 214 215 216
      expected_process_name = name.format(hash=h)

      self.assertIn(expected_process_name, process_name_list)

  def test_nextcloud_installation(self):
217
    can_install_path = os.path.join(self.nextcloud_path, 'config/CAN_INSTALL')
218

219
    self.assertTrue(os.path.exists(self.nextcloud_path))
220
    self.assertFalse(os.path.exists(can_install_path))
221
    self.assertTrue(os.path.exists(os.path.join(self.nextcloud_path, 'config/config.php')))
222

223
    php_bin = os.path.join(self.partition_dir, 'bin/php')
224 225
    nextcloud_status = subprocess.check_output([
      php_bin,
226
      os.path.join(self.nextcloud_path, 'occ'),
227 228 229 230 231 232 233
      'status',
      '--output',
      'json'])
    json_status = json.loads(nextcloud_status)
    self.assertTrue(json_status['installed'], True)

  def test_nextcloud_config(self):
234 235
    config_file = os.path.join(self.nextcloud_path, 'config/config.php')
    php_script = os.path.join(self.partition_dir, 'test.php')
236 237 238
    with open(php_script, 'w') as f:
      f.write("<?php include('%s'); echo json_encode($CONFIG); ?>" % config_file)

239 240
    php_bin = os.path.join(self.partition_dir, 'bin/php')
    occ = os.path.join(self.nextcloud_path, 'occ')
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
    config_result =  subprocess.check_output([
      php_bin,
      '-f',
      php_script
    ])
    config_dict = json.loads(config_result)
    #remove generated values
    config_dict.pop('instanceid')
    config_dict.pop('passwordsalt')
    config_dict.pop('secret')
    config_dict.pop('version')
    expected_dict = self.getNextcloudConfig()
    self.assertEqual(config_dict, expected_dict)
    collabora_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "richdocuments",
      "wopi_url"
    ])
261
    self.assertEqual(collabora_config.strip(), b'https://collabora.host.vifib.net/')
262 263 264 265 266 267 268
    stun_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "spreed",
      "stun_servers"
    ])
269
    self.assertEqual(stun_config.strip(), b'["turn.vifib.com:5349"]')
270 271 272 273 274 275 276
    turn_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "spreed",
      "turn_servers"
    ])
277 278
    self.assertEqual(turn_config.strip(), b'[{"server":"","secret":"","protocols":"udp,tcp"}]')
    news_config_file = os.path.join(self.partition_dir, 'srv/data/news/config/config.ini')
279 280
    with open(news_config_file) as f:
      config = f.read()
281
    self.assertRegex(config, r"(useCronUpdates\s+=\s+false)")
282 283


284
class TestNextCloudParameters(NextCloudTestCase):
285 286
  __partition_reference__ = 'ncp'

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  @classmethod
  def getInstanceParameterDict(cls):
    return {
      'instance.mail-from': "Nextcloud-Test",
      'instance.mail-domain': "test@example.com",
      'instance.mail-smtpauthtype': "LOGIN",
      'instance.mail-smtpauth': 1,
      'instance.mail-smtpport': 4588,
      'instance.mail-smtphost': '127.0.0.1',
      'instance.mail-smtpname': 'mail.example.net',
      'instance.mail-smtppassword': 'dwsofjsd',
      'instance.collabora-url': 'https://my-custom.collabora.net',
      'instance.stun-server': 'stun.example.net:5439',
      'instance.turn-server': 'turn.example.net:5439',
      'instance.turn-secret': 'c4f0ead40a49bbbac3c58f7b9b43990f78ebd96900757ae67e10190a3a6b6053',
      'instance.cli-url': 'nextcloud.example.com',
      'instance.trusted-domain-1': 'nextcloud.example.com',
      'instance.trusted-domain-2': 'nextcloud.proxy.com',
      'instance.trusted-proxy-list': '2001:67c:1254:e:89::5df3 127.0.0.1 10.23.1.3',
    }

  def test_nextcloud_config_with_parameters(self):
309 310
    config_file = os.path.join(self.nextcloud_path, 'config/config.php')
    php_script = os.path.join(self.partition_dir, 'test.php')
311 312 313
    with open(php_script, 'w') as f:
      f.write("<?php include('%s'); echo json_encode($CONFIG); ?>" % config_file)

314 315
    php_bin = os.path.join(self.partition_dir, 'bin/php')
    occ = os.path.join(self.nextcloud_path, 'occ')
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    config_result =  subprocess.check_output([
      php_bin,
      '-f',
      php_script
    ])
    config_dict = json.loads(config_result)
    #remove generated values
    config_dict.pop('instanceid')
    config_dict.pop('passwordsalt')
    config_dict.pop('secret')
    config_dict.pop('version')
    instance_parameter_dict = dict(
      mail_domain="test@example.com",
      mail_from_address="Nextcloud-Test",
      mail_smtpauth=1,
      mail_smtpauthtype="LOGIN",
      mail_smtphost="127.0.0.1",
      mail_smtpport="4588",
      mail_smtppassword="dwsofjsd",
      mail_smtpname="mail.example.net",
      cli_url="nextcloud.example.com",
      partition_dir=self.partition_dir,
      trusted_domain_list=json.dumps([
339
        "[%s]:9988" % self._ipv6_address,
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
        "nextcloud.example.com",
        "nextcloud.proxy.com"
      ]),
      trusted_proxy_list=json.dumps([
        "2001:67c:1254:e:89::5df3",
        "127.0.0.1",
        "10.23.1.3"
      ])
    )
    expected_dict = self.getNextcloudConfig(instance_parameter_dict)
    self.assertEqual(config_dict, expected_dict)
    collabora_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "richdocuments",
      "wopi_url"
    ])
358
    self.assertEqual(collabora_config.strip(), b'https://my-custom.collabora.net')
359 360 361 362 363 364 365
    stun_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "spreed",
      "stun_servers"
    ])
366
    self.assertEqual(stun_config.strip(), b'["stun.example.net:5439"]')
367 368 369 370 371 372 373
    turn_config = subprocess.check_output([
      php_bin,
      occ,
      "config:app:get",
      "spreed",
      "turn_servers"
    ])
374 375 376
    self.assertEqual(
        turn_config.strip(),
        b'[{"server":"turn.example.net:5439","secret":"c4f0ead40a49bbbac3c58f7b9b43990f78ebd96900757ae67e10190a3a6b6053","protocols":"udp,tcp"}]')