[Notes] [Git][BuildStream/buildstream][aevri/prompt-config] 5 commits:

Angelos Evripiotis pushed to branch aevri/prompt-config at BuildStream / buildstream

Commits:

67d855d1
by Angelos Evripiotis at 2018-11-15T10:31:00Z
```
_yaml: document node_get()'s default_value arg
```

31fd24b6

by Angelos Evripiotis at 2018-11-15T10:54:41Z

_context: allow 'terminate' for scheduler.on-error

Enable this option of 'terminate', which is mentioned in userconfig.yaml
and handled in _frontend/app.py:_handle_failure(). It appears to have
been left out of the valid_actions as an oversight.

Originally introduced in
https://gitlab.com/BuildStream/buildstream/commit/2622d5da9bd9fefd87436613d6e3e9770fdd0f28

c4e88413

by Angelos Evripiotis at 2018-11-16T11:07:33Z

_context: refactor, extract _node_get_option_str

Use a new helper function to simplify working with nodes that can only
accept certain strings. This will be used when adding the prompt.*
config options.

In later work we can see if this function would be useful elsewhere, and
could be added to '_yaml.py'.

b8a77e47

by Angelos Evripiotis at 2018-11-16T11:08:11Z

Add prompt.auto-init buildstream.conf option

Provide an option in buildstream.conf to disable the 'Would you like to
...' prompt when we cannot resolve a project.

Some users prefer not to be interrupted by such prompts, so pave the way
to creating options to disable all those that might get in the way.

Follow the example of the advice.* options 'git-config', and create a
namespace for these UI options grouped by behaviour, rather than an
over-reaching 'ui.*' namespace. In later work perhaps we'll also add
'advice.*' options.

Add a NEWS item for this.

02d4223a

by Angelos Evripiotis at 2018-11-16T11:08:11Z

Add prompt.workspace-... options

Provide options in project.conf to disable the 'Are you sure ...'
prompts when making destructive changes:

- Add prompt.really-workspace-close-remove-dir
- Add prompt.really-workspace-reset-hard

Add a NEWS item for these.

Changes:

NEWS

@@ -45,6 +45,12 @@ buildstream 1.3.1
      instead of just a specially-formatted build-root with a `root` and `scratch`
      subdirectory.
 +  o The buildstream.conf file learned new 'prompt.auto-init',
 +    'prompt.really-workspace-close-remove-dir', and
 +    'prompt.really-workspace-reset-hard' options. These allow users to suppress
 +    certain confirmation prompts, e.g.  double-checking that the user meant to
 +    run the command as typed.
++
  =================
  buildstream 1.1.5

buildstream/_context.py

@@ -104,6 +104,18 @@ class Context():
          # What to do when a build fails in non interactive mode
          self.sched_error_action = 'continue'
 +        # Boolean, whether to offer to create a project for the user, if we are
 +        # invoked outside of a directory where we can resolve the project.
 +        self.prompt_auto_init = None
++
 +        # Boolean, whether we double-check with the user that they meant to
 +        # remove a workspace directory.
 +        self.prompt_workspace_close_remove_dir = None
++
 +        # Boolean, whether we double-check with the user that they meant to do
 +        # a hard reset of a workspace, potentially losing changes.
 +        self.prompt_workspace_reset_hard = None
++
          # Whether elements must be rebuilt when their dependencies have changed
          self._strict_build_plan = None
@@ -160,7 +172,7 @@ class Context():
          _yaml.node_validate(defaults, [
              'sourcedir', 'builddir', 'artifactdir', 'logdir',
              'scheduler', 'artifacts', 'logging', 'projects',
 -            'cache'
 +            'cache', 'prompt'
          ])
          for directory in ['sourcedir', 'builddir', 'artifactdir', 'logdir']:
@@ -206,12 +218,34 @@ class Context():
              'on-error', 'fetchers', 'builders',
              'pushers', 'network-retries'
          ])
 -        self.sched_error_action = _yaml.node_get(scheduler, str, 'on-error')
 +        self.sched_error_action = _node_get_option_str(
 +            scheduler, 'on-error', ['continue', 'quit', 'terminate'])
          self.sched_fetchers = _yaml.node_get(scheduler, int, 'fetchers')
          self.sched_builders = _yaml.node_get(scheduler, int, 'builders')
          self.sched_pushers = _yaml.node_get(scheduler, int, 'pushers')
          self.sched_network_retries = _yaml.node_get(scheduler, int, 'network-retries')
 +        # Load prompt preferences
 +        #
 +        # We convert string options to booleans here, so we can be both user
 +        # and coder-friendly. The string options are worded to match the
 +        # responses the user would give at the cli, for least surprise. The
 +        # booleans are converted here because it's easiest to eyeball that the
 +        # strings are right.
 +        #
 +        prompt = _yaml.node_get(
 +            defaults, Mapping, 'prompt')
 +        _yaml.node_validate(prompt, [
 +            'auto-init', 'really-workspace-close-remove-dir',
 +            'really-workspace-reset-hard',
 +        ])
 +        self.prompt_auto_init = _node_get_option_str(
 +            prompt, 'auto-init', ['ask', 'no']) == 'ask'
 +        self.prompt_workspace_close_remove_dir = _node_get_option_str(
 +            prompt, 'really-workspace-close-remove-dir', ['ask', 'yes']) == 'ask'
 +        self.prompt_workspace_reset_hard = _node_get_option_str(
 +            prompt, 'really-workspace-reset-hard', ['ask', 'yes']) == 'ask'
++
          # Load per-projects overrides
          self._project_overrides = _yaml.node_get(defaults, Mapping, 'projects', default_value={})
@@ -222,13 +256,6 @@ class Context():
          profile_end(Topics.LOAD_CONTEXT, 'load')
 -        valid_actions = ['continue', 'quit']
 -        if self.sched_error_action not in valid_actions:
 -            provenance = _yaml.node_get_provenance(scheduler, 'on-error')
 -            raise LoadError(LoadErrorReason.INVALID_DATA,
 -                            "{}: on-error should be one of: {}".format(
 -                                provenance, ", ".join(valid_actions)))
+-
      @property
      def artifactcache(self):
          if not self._artifactcache:
@@ -581,3 +608,30 @@ class Context():
              os.environ['XDG_CONFIG_HOME'] = os.path.expanduser('~/.config')
          if not os.environ.get('XDG_DATA_HOME'):
              os.environ['XDG_DATA_HOME'] = os.path.expanduser('~/.local/share')
++
++
 +# _node_get_option_str()
 +#
 +# Fetches a value from a dictionary node, and makes sure it's one of the
 +# pre-defined options.
 +#
 +# Args:
 +#    node (dict): The dictionary node
 +#    key (str): The key to get a value for in node
 +#    allowed_options (iterable): Only accept these values
 +#
 +# Returns:
 +#    The value if found in node
 +#
 +# Raises:
 +#    LoadError, when the value found is not of the expected type, or is not
 +#    found.
 +#
 +def _node_get_option_str(node, key, allowed_options):
 +        result = _yaml.node_get(node, str, key)
 +        if result not in allowed_options:
 +            provenance = _yaml.node_get_provenance(node, key)
 +            raise LoadError(LoadErrorReason.INVALID_DATA,
 +                            "{}: {} should be one of: {}".format(
 +                                provenance, key, ", ".join(allowed_options)))
 +        return result

buildstream/_frontend/app.py

@@ -221,9 +221,10 @@ class App():
              # Let's automatically start a `bst init` session in this case
              if e.reason == LoadErrorReason.MISSING_PROJECT_CONF and self.interactive:
                  click.echo("A project was not detected in the directory: {}".format(directory), err=True)
 -                click.echo("", err=True)
 -                if click.confirm("Would you like to create a new project here ?"):
 -                    self.init_project(None)
 +                if self.context.prompt_auto_init:
 +                    click.echo("", err=True)
 +                    if click.confirm("Would you like to create a new project here?"):
 +                        self.init_project(None)
              self._error_exit(e, "Error loading project")

buildstream/_frontend/cli.py

@@ -743,7 +743,7 @@ def workspace_close(app, remove_dir, all_, elements):
          if nonexisting:
              raise AppError("Workspace does not exist", detail="\n".join(nonexisting))
 -        if app.interactive and remove_dir:
 +        if app.interactive and remove_dir and app.context.prompt_workspace_close_remove_dir:
              if not click.confirm('This will remove all your changes, are you sure?'):
                  click.echo('Aborting', err=True)
                  sys.exit(-1)
@@ -777,7 +777,7 @@ def workspace_reset(app, soft, track_, all_, elements):
          if all_ and not app.stream.workspace_exists():
              raise AppError("No open workspaces to reset")
 -        if app.interactive and not soft:
 +        if app.interactive and not soft and app.context.prompt_workspace_reset_hard:
              if not click.confirm('This will remove all your changes, are you sure?'):
                  click.echo('Aborting', err=True)
                  sys.exit(-1)

buildstream/_yaml.py

@@ -351,6 +351,7 @@ _sentinel = object()
  #    expected_type (type): The expected type for the value being searched
  #    key (str): The key to get a value for in node
  #    indices (list of ints): Optionally decend into lists of lists
 +#    default_value: Optionally return this value if the key is not found
+ #
  # Returns:
  #    The value if found in node, otherwise default_value is returned

buildstream/data/userconfig.yaml

@@ -97,3 +97,35 @@ logging:
      [%{elapsed}][%{key}][%{element}] %{action} %{message}
 +#
 +#    Prompt overrides
 +#
 +# Here you can suppress 'are you sure?' and other kinds of prompts by supplying
 +# override values. Note that e.g. 'yes' and 'no' have the same meaning here as
 +# they do in the actual prompt.
 +#
 +prompt:
++
 +  # Whether to create a project with 'bst init' if we are invoked outside of a
 +  # directory where we can resolve the project.
 +  #
 +  #  ask - Prompt the user to choose.
 +  #  no  - Never create the project.
 +  #
 +  auto-init: ask
++
 +  # Whether to really proceed with 'bst workspace close --remove-dir' removing
 +  # a workspace directory, potentially losing changes.
 +  #
 +  #  ask - Ask the user if they are sure.
 +  #  yes - Always remove, without asking.
 +  #
 +  really-workspace-close-remove-dir: ask
++
 +  # Whether to really proceed with 'bst workspace reset' doing a hard reset of
 +  # a workspace, potentially losing changes.
 +  #
 +  #  ask - Ask the user if they are sure.
 +  #  yes - Always hard reset, without asking.
 +  #
 +  really-workspace-reset-hard: ask

[Notes] [Git][BuildStream/buildstream][aevri/prompt-config] 5 commits: _yaml: document node_get()'s default_value arg

Angelos Evripiotis pushed to branch aevri/prompt-config at BuildStream / buildstream

Commits:

6 changed files:

Changes: