[Notes] [Git][BuildStream/buildstream][Qinusty/563-cache-quota-restricti

Tristan Van Berkom pushed to branch Qinusty/563-cache-quota-restriction at BuildStream / buildstream

Commits:

98616f50

by Qinusty at 2018-08-03T16:30:24Z

Merge branch 'Qinusty/backport-576' into 'bst-1.2'

Backport unhandled exception fix in cascache.py

See merge request BuildStream/buildstream!602

111c0fde

by Mathieu Bridon at 2018-08-05T09:40:22Z

doc: Build the docs without Buildstream installed

d9b2de3e

by Tristan Van Berkom at 2018-08-05T10:06:42Z

__main__.py: Adding private entry point so we can run BuildStream without installing

This is needed to build docs without installing BuildStream.

10d57730

by Tristan Van Berkom at 2018-08-05T10:06:42Z

doc: Some modifications to the bst2html program

  o Added feature to allow running shell commands

  o Removed unused codepaths to launch bst commands through the script,
    this program is anyway only used to parse and run the session files.

  o Fixed previous patch to run BuildStream uninstalled with
    the subprocess module, as running it in the same interpretor
    causes a bunch of problems.

574fb6ac

by Tristan Van Berkom at 2018-08-05T10:06:42Z

HACKING.rst: It is not longer required to install BuildStream to build the docs.

81fdd088

by Tristan Van Berkom at 2018-08-05T10:59:38Z

Merge branch 'tristan/build-docs-1.2' into 'bst-1.2'

Build documentation without installing (backport to 1.2)

See merge request BuildStream/buildstream!606

16221c6b

by Josh Smith at 2018-08-06T09:49:13Z

_context.py: Cache size is now restricted to available disk space

This address issue #491.

When attempting to run buildstream with a configuration specifying
a cache quota larger than your available disk space, buildstream
will alert the user and exit.

Note:
This takes into consideration your current cache usage and
therefore restricts the overall size of your artifact cache folder.

Changes:

.gitlab-ci.yml

@@ -143,7 +143,6 @@ docs:
    - pip3 install sphinx-click
    - pip3 install sphinx_rtd_theme
    - cd dist && ./unpack.sh && cd buildstream
 -  - pip3 install .
    - make BST_FORCE_SESSION_REBUILD=1 -C doc
    - cd ../..
    - mv dist/buildstream/doc/build/html public

HACKING.rst

@@ -256,9 +256,6 @@ using pip or some other mechanism::
    # Additional optional dependencies required
    pip3 install --user arpy
 -Furthermore, the documentation build requires that BuildStream itself
 -be installed, as it will be used in the process of generating its docs.
+-
  To build the documentation, just run the following::
    make -C doc

buildstream/__main__.py

 +##################################################################
 +#                      Private Entry Point                       #
 +##################################################################
 +#
 +# This allows running the cli when BuildStream is uninstalled,
 +# as long as BuildStream repo is in PYTHONPATH, one can run it
 +# with:
 +#
 +#    python3 -m buildstream [program args]
 +#
 +# This is used when we need to run BuildStream before installing,
 +# like when we build documentation.
 +#
 +if __name__ == '__main__':
 +    # pylint: disable=no-value-for-parameter
 +    from ._frontend.cli import cli
 +    cli()

buildstream/_context.py

@@ -197,29 +197,55 @@ class Context():
                              "\nValid values are, for example: 800M 10G 1T 50%\n"
                              .format(str(e))) from e
 -        # If we are asked not to set a quota, we set it to the maximum
 -        # disk space available minus a headroom of 2GB, such that we
 -        # at least try to avoid raising Exceptions.
 +        # Headroom intended to give BuildStream a bit of leeway.
 +        # This acts as the minimum size of cache_quota and also
 +        # is taken from the user requested cache_quota.
+         #
 -        # Of course, we might still end up running out during a build
 -        # if we end up writing more than 2G, but hey, this stuff is
 -        # already really fuzzy.
 -        #
 -        if cache_quota is None:
 -            stat = os.statvfs(artifactdir_volume)
 -            # Again, the artifact directory may not yet have been
 -            # created
 -            if not os.path.exists(self.artifactdir):
 -                cache_size = 0
 -            else:
 -                cache_size = utils._get_dir_size(self.artifactdir)
 -            cache_quota = cache_size + stat.f_bsize * stat.f_bavail
+-
          if 'BST_TEST_SUITE' in os.environ:
              headroom = 0
          else:
              headroom = 2e9
 +        stat = os.statvfs(artifactdir_volume)
 +        available_space = (stat.f_bsize * stat.f_bavail)
++
 +        # Again, the artifact directory may not yet have been created yet
 +        #
 +        if not os.path.exists(self.artifactdir):
 +            cache_size = 0
 +        else:
 +            cache_size = utils._get_dir_size(self.artifactdir)
++
 +        # Ensure system has enough storage for the cache_quota
 +        #
 +        # If cache_quota is none, set it to the maximum it could possibly be.
 +        #
 +        # Also check that cache_quota is atleast as large as our headroom.
 +        #
 +        if cache_quota is None:  # Infinity, set to max system storage
 +            cache_quota = cache_size + available_space
 +        if cache_quota < headroom:  # Check minimum
 +            raise LoadError(LoadErrorReason.INVALID_DATA,
 +                            "Invalid cache quota ({}): ".format(utils._pretty_size(cache_quota)) +
 +                            "BuildStream requires a minimum cache quota of 2G.")
 +        elif cache_quota > cache_size + available_space:  # Check maximum
 +            raise LoadError(LoadErrorReason.INVALID_DATA,
 +                            ("Your system does not have enough available " +
 +                             "space to support the cache quota specified.\n" +
 +                             "You currently have:\n" +
 +                             "- {used} of cache in use at {local_cache_path}\n" +
 +                             "- {available} of available system storage").format(
 +                                 used=utils._pretty_size(cache_size),
 +                                 local_cache_path=self.artifactdir,
 +                                 available=utils._pretty_size(available_space)))
++
 +        # Place a slight headroom (2e9 (2GB) on the cache_quota) into
 +        # cache_quota to try and avoid exceptions.
 +        #
 +        # Of course, we might still end up running out during a build
 +        # if we end up writing more than 2G, but hey, this stuff is
 +        # already really fuzzy.
 +        #
          self.cache_quota = cache_quota - headroom
          self.cache_lower_threshold = self.cache_quota / 2

buildstream/utils.py

@@ -612,6 +612,27 @@ def _parse_size(size, volume):
      return int(num) * 1024**units.index(unit)
 +# _pretty_size()
 +#
 +# Converts a number of bytes into a string representation in KB, MB, GB, TB
 +# represented as K, M, G, T etc.
 +#
 +# Args:
 +#   size (int): The size to convert in bytes.
 +#   dec_places (int): The number of decimal places to output to.
 +#
 +# Returns:
 +#   (str): The string representation of the number of bytes in the largest
 +def _pretty_size(size, dec_places=0):
 +    psize = size
 +    unit = 'B'
 +    for unit in ('B', 'K', 'M', 'G', 'T'):
 +        if psize < 1024:
 +            break
 +        else:
 +            psize /= 1024
 +    return "{size:g}{unit}".format(size=round(psize, dec_places), unit=unit)
++
  # A sentinel to be used as a default argument for functions that need
  # to distinguish between a kwarg set to None and an unset kwarg.
  _sentinel = object()

doc/Makefile

@@ -31,6 +31,9 @@ ifneq ($(strip $(BST_FORCE_SESSION_REBUILD)),)
  BST2HTMLOPTS = --force
  endif
 +# Help Python find buildstream and its plugins
 +PYTHONPATH=$(CURDIR)/..:$(CURDIR)/../buildstream/plugins
++
  .PHONY: all clean templates templates-clean sessions sessions-prep sessions-clean html devhelp
@@ -65,7 +68,6 @@ define plugin-doc-skeleton
  endef
 -# We set PYTHONPATH here because source/conf.py sys.modules hacks dont seem to help sphinx-build import the plugins
  all: html devhelp
  clean: templates-clean sessions-clean
@@ -103,7 +105,7 @@ sessions-prep:
+ #
  sessions: sessions-prep
  	for file in $(wildcard sessions/*.run); do		\
 -	    $(BST2HTML) $(BST2HTMLOPTS) --description $$file;	\
 +	    PYTHONPATH=$(PYTHONPATH) $(BST2HTML) $(BST2HTMLOPTS) $$file;	\
  	done
  sessions-clean:
@@ -114,7 +116,7 @@ sessions-clean:
+ #
  html devhelp: templates sessions
  	@echo "Building $@..."
 -	PYTHONPATH=$(CURDIR)/../buildstream/plugins \
 +	PYTHONPATH=$(PYTHONPATH) \
  	    $(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(BUILDDIR)/$@" \
  	    $(wildcard source/*.rst) \
  	    $(wildcard source/tutorial/*.rst) \

doc/bst2html.py

@@ -204,7 +204,7 @@ def workdir(source_cache=None):
          yield (tempdir, bst_config_file, source_cache)
 -# run_command()
 +# run_bst_command()
+ #
  # Runs a command
+ #
@@ -216,10 +216,30 @@ def workdir(source_cache=None):
  # Returns:
  #    (str): The colorized combined stdout/stderr of BuildStream
+ #
 -def run_command(config_file, directory, command):
 -    click.echo("Running command in directory '{}': bst {}".format(directory, command), err=True)
 +def run_bst_command(config_file, directory, command):
 +    click.echo("Running bst command in directory '{}': bst {}".format(directory, command), err=True)
 -    argv = ['bst', '--colors', '--config', config_file] + shlex.split(command)
 +    argv = ['python3', '-m', 'buildstream', '--colors', '--config', config_file] + shlex.split(command)
 +    p = subprocess.Popen(argv, cwd=directory, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 +    out, _ = p.communicate()
 +    return out.decode('utf-8').strip()
++
++
 +# run_shell_command()
 +#
 +# Runs a command
 +#
 +# Args:
 +#    directory (str): The project directory
 +#    command (str): A shell command
 +#
 +# Returns:
 +#    (str): The combined stdout/stderr of the shell command
 +#
 +def run_shell_command(directory, command):
 +    click.echo("Running shell command in directory '{}': {}".format(directory, command), err=True)
++
 +    argv = shlex.split(command)
      p = subprocess.Popen(argv, cwd=directory, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
      out, _ = p.communicate()
      return out.decode('utf-8').strip()
@@ -373,12 +393,18 @@ def run_session(description, tempdir, source_cache, palette, config_file, force)
          # Get the command string
          command_str = _yaml.node_get(command, str, 'command')
 +        # Check whether this is a shell command and not a bst command
 +        is_shell = _yaml.node_get(command, bool, 'shell', default_value=False)
++
          # Check if there is fake output
          command_fake_output = _yaml.node_get(command, str, 'fake-output', default_value=None)
          # Run the command, or just use the fake output
          if command_fake_output is None:
 -            command_out = run_command(config_file, directory, command_str)
 +            if is_shell:
 +                command_out = run_shell_command(directory, command_str)
 +            else:
 +                command_out = run_bst_command(config_file, directory, command_str)
          else:
              command_out = command_fake_output
@@ -414,14 +440,8 @@ def run_session(description, tempdir, source_cache, palette, config_file, force)
  @click.option('--palette', '-p', default='tango',
                type=click.Choice(['solarized', 'solarized-xterm', 'tango', 'xterm', 'console']),
                help="Selects a palette for the output style")
 -@click.option('--output', '-o',
 -              type=click.Path(file_okay=True, dir_okay=False, writable=True),
 -              help="A file to store the output")
 -@click.option('--description', '-d',
 -              type=click.Path(file_okay=True, dir_okay=False, readable=True),
 -              help="A file describing what to do")
 -@click.argument('command', type=click.STRING, nargs=-1)
 -def run_bst(directory, force, source_cache, description, palette, output, command):
 +@click.argument('description', click.Path(file_okay=True, dir_okay=False, readable=True))
 +def run_bst(directory, force, source_cache, description, palette):
      """Run a bst command and capture stdout/stderr in html
      This command normally takes a description yaml file, see the HACKING
@@ -430,45 +450,8 @@ def run_bst(directory, force, source_cache, description, palette, output, comman
      if not source_cache and os.environ.get('BST_SOURCE_CACHE'):
          source_cache = os.environ['BST_SOURCE_CACHE']
 -    if output is not None and not check_needs_build(None, output, force=force):
 -        click.echo("No need to rebuild {}".format(output))
 -        return 0
+-
      with workdir(source_cache=source_cache) as (tempdir, config_file, source_cache):
+-
 -        if description:
 -            run_session(description, tempdir, source_cache, palette, config_file, force)
 -            return 0
+-
 -        # Run a command specified on the CLI
 -        #
 -        if not directory:
 -            directory = os.getcwd()
 -        else:
 -            directory = os.path.abspath(directory)
 -            directory = os.path.realpath(directory)
+-
 -        if not command:
 -            command = []
 -        command_str = " ".join(command)
+-
 -        # Run the command
 -        #
 -        command_out = run_command(config_file, directory, command_str)
+-
 -        # Generate a nice html div for this output
 -        #
 -        converted = generate_html(command_out, directory, config_file,
 -                                  source_cache, tempdir, palette,
 -                                  command_str)
+-
 -    if output is None:
 -        click.echo(converted)
 -    else:
 -        outdir = os.path.dirname(output)
 -        os.makedirs(outdir, exist_ok=True)
 -        with open(output, 'wb') as f:
 -            f.write(converted.encode('utf-8'))
 +        run_session(description, tempdir, source_cache, palette, config_file, force)
      return 0

[Notes] [Git][BuildStream/buildstream][Qinusty/563-cache-quota-restriction] 7 commits: Merge branch 'Qinusty/backport-576' into 'bst-1.2'

Tristan Van Berkom pushed to branch Qinusty/563-cache-quota-restriction at BuildStream / buildstream

Commits:

7 changed files:

Changes: