python/samba/tests/samba_tool/provision_lmdb_size.py

   1 # Unix SMB/CIFS implementation.
   2 # Copyright (C) Catalyst IT Ltd. 2019
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 from samba.tests.samba_tool.base import SambaToolCmdTest
  19 import os
  20 import shutil
  21
  22
  23 class ProvisionLmdbSizeTestCase(SambaToolCmdTest):
  24     """Test setting of the lmdb map size during provision"""
  25
  26     def setUp(self):
  27         super().setUp()
  28         self.tempsambadir = os.path.join(self.tempdir, "samba")
  29         os.mkdir(self.tempsambadir)
  30
  31     # provision a domain and set the lmdb map size to size
  32     #
  33     # returns the tuple (ret, stdout, stderr)
  34     def provision(self, size=None):
  35         command = (
  36             "samba-tool " +
  37             "domain provision " +
  38             "--realm=foo.example.com " +
  39             "--domain=FOO " +
  40             ("--targetdir=%s " % self.tempsambadir) +
  41             "--backend-store=mdb " +
  42             "--use-ntvfs "
  43         )
  44         if size:
  45             command += ("--backend-store-size=%s" % size)
  46
  47         return self.run_command(command)
  48
  49     #
  50     # Get the lmdb map size for the specified command
  51     #
  52     # While there is a python lmdb package available we use the lmdb command
  53     # line utilities to avoid introducing a dependency.
  54     #
  55     def get_lmdb_environment_size(self, path):
  56         (result, out, err) = self.run_command("mdb_stat -ne %s" % path)
  57         if result:
  58             self.fail("Unable to run mdb_stat\n")
  59         for line in out.split("\n"):
  60             line = line.strip()
  61             if line.startswith("Map size:"):
  62                 line = line.replace(" ", "")
  63                 (label, size) = line.split(":")
  64                 return int(size)
  65
  66     #
  67     # Check the lmdb files created by provision and ensure that the map size
  68     # has been set to size.
  69     #
  70     # Currently this is all the *.ldb files in private/sam.ldb.d
  71     #
  72     def check_lmdb_environment_sizes(self, size):
  73         directory = os.path.join(self.tempsambadir, "private", "sam.ldb.d")
  74         for name in os.listdir(directory):
  75             if name.endswith(".ldb"):
  76                 path = os.path.join(directory, name)
  77                 s = self.get_lmdb_environment_size(path)
  78                 if s != size:
  79                     self.fail("File %s, size=%d larger than %d" %
  80                               (name, s, size))
  81
  82     #
  83     # Ensure that if --backend-store-size is not specified the default of
  84     # 8Gb is used
  85     def test_default(self):
  86         (result, out, err) = self.provision()
  87         self.assertEqual(0, result)
  88         self.check_lmdb_environment_sizes(8 * 1024 * 1024 * 1024)
  89
  90     def test_64Mb(self):
  91         (result, out, err) = self.provision("64Mb")
  92         self.assertEqual(0, result)
  93         self.check_lmdb_environment_sizes(64 * 1024 * 1024)
  94
  95     def test_1Gb(self):
  96         (result, out, err) = self.provision("1Gb")
  97         self.assertEqual(0, result)
  98         self.check_lmdb_environment_sizes(1 * 1024 * 1024 * 1024)
  99
 100     # 128Mb specified in bytes.
 101     #
 102     def test_134217728b(self):
 103         (result, out, err) = self.provision("134217728b")
 104         self.assertEqual(0, result)
 105         self.check_lmdb_environment_sizes(134217728)
 106
 107     def test_no_unit_suffix(self):
 108         (result, out, err) = self.run_command(
 109             'samba-tool domain provision --backend-store-size "2"')
 110         self.assertGreater(result, 0)
 111         self.assertRegex(err,
 112                          r"--backend-store-size invalid suffix ''")
 113
 114     def test_invalid_unit_suffix(self):
 115         (result, out, err) = self.run_command(
 116             'samba-tool domain provision --backend-store-size "2 cd"')
 117         self.assertGreater(result, 0)
 118         self.assertRegex(err,
 119                          r"--backend-store-size invalid suffix 'cd'")
 120
 121     def test_non_numeric(self):
 122         (result, out, err) = self.run_command(
 123             'samba-tool domain provision --backend-store-size "two Gb"')
 124         self.assertGreater(result, 0)
 125         self.assertRegex(
 126             err,
 127             r"backend-store-size option requires a numeric value, with an"
 128             " optional unit suffix")
 129
 130     def tearDown(self):
 131         super().tearDown()
 132         shutil.rmtree(self.tempsambadir)