[Notes] [Git][BuildStream/buildstream][valentindavid/crash_in_scheduler_857] 78 commits: using_commands.rst: Split out top level commands and subcommand groups

[Valentin David <gitlab mg gitlab com>]

Title: GitLab

Valentin David pushed to branch valentindavid/crash_in_scheduler_857 at BuildStream / buildstream

Commits:

• 383142e3
  by James Ennis at 2019-01-22T12:32:43Z

  using_commands.rst: Split out top level commands and subcommand groups
  

• ac135333
  by James Ennis at 2019-01-22T12:32:43Z

  using_commands.rst: Add the source checkout command
  

• a3fc350f
  by James Ennis at 2019-01-22T12:32:43Z

  Move push and pull to the new artifact subcommand group
  
  This commit also ensures that if we try to use the 'old' commands,
  BuildStream will fail and instruct the user to use the new command.
  

• 9eefe863
  by James Ennis at 2019-01-22T12:32:43Z

  cli: Add artifact checkout subcommand
  
  'artifact checkout' has slightly different behaviour from 'checkout',
  that is, either '--directory' or '--tar' are now required options.
  This is a step towards allowing checkout to take multiple args.
  

• fbd15939
  by James Ennis at 2019-01-22T12:32:43Z

  Mark 'old' checkout command as obsolete
  
  This commit marks 'bst checkout' as a 'hidden' command. If used,
  the user will be prompted to use the new 'bst artifact checkout'
  command.
  
  All tests which used 'bst checkout' have been modified to use
  the new artifact sub-command.
  
  This partially solves #822.
  

• 9e8034e9
  by James Ennis at 2019-01-22T12:32:43Z

  Add NEWS entry describing the deprecation of checkout, pull and push
  

• 1bccf1d2
  by James Ennis at 2019-01-22T12:38:40Z

  using_commands.rst: Split out the artifact subcommands
  

• d9072371
  by James Ennis at 2019-01-22T12:38:40Z

  using_commands.rst: Add artifact log subcommand
  

• 077d5a96
  by James Ennis at 2019-01-22T12:41:29Z

  Change bst checkout/pull/push references to bst artifact checkout/pull/push
  

• ea2fbe4d
  by James Ennis at 2019-01-22T13:02:14Z

  man: Regenerate all of our man pages
  
  Due to an upstream click_man issue:
  https://github.com/click-contrib/click-man/issues/10
  generating the man pages with our current setup.py only generates
  a man page for bst-artifact-server, our first entry point.
  I then had to remove this entry point from setup.py and regenerate to
  obtain man pages for the commands in cli.py
  

• 9c2a6b93
  by James Ennis at 2019-01-22T15:08:17Z

  Merge branch 'jennis/migrate_pull_push_commands' into 'master'
  
  Move push/pull/checkout to the artifact subcommand group
  
  See merge request BuildStream/buildstream!1045

• 35377522
  by James Ennis at 2019-01-22T15:28:13Z

  cli.py: Add an obsoletion note to our deprecated commands.
  
  Click 7.0 allows us to declare commands as 'hidden'.
  However, sphinx-click and click-man still generate these hidden
  commands in the documentation and man pages, respectively.
  
  This is a stop gap solution until the upstream issues (tracked in
  issues #879 and #881) have been addressed.
  

• 76148785
  by James Ennis at 2019-01-22T16:15:20Z

  Merge branch 'jennis/add_obsoletion_note' into 'master'
  
  Add an obsoletion note to our deprecated commands.
  
  See merge request BuildStream/buildstream!1097

• 1443c542
  by Tristan Van Berkom at 2019-01-22T16:26:56Z

  _scheduler: Fix dont display a failure for terminated jobs
  
  This fixes a recent regression introduced in c2fc2a5ea
  

• 6e5c9987
  by Tristan Van Berkom at 2019-01-22T17:14:50Z

  Merge branch 'tristan/fix-terminated-status' into 'master'
  
  _scheduler: Fix dont display a failure for terminated jobs
  
  See merge request BuildStream/buildstream!1096

• 3315b9a1
  by Tristan Van Berkom at 2019-01-22T18:46:24Z

  tests/integration/pullbuildtrees.py: Fix the non-integration case.
  
  This test has one test case which is marked as an integration test,
  and the other is not an integration test, but was using the integration
  cli. The integration cli does not work correctly if not run in
  integration mode.
  
  This was causing an error locally in conftest.py when trying to
  create a tmpdir inside a nonexisting integration cache directory.
  

• 56e857f4
  by Tristan Van Berkom at 2019-01-22T19:59:57Z

  Merge branch 'tristan/fix-pullbuildtrees-test' into 'master'
  
  tests/integration/pullbuildtrees.py: Fix the non-integration case.
  
  See merge request BuildStream/buildstream!1098

• 3895571a
  by Chandan Singh at 2019-01-23T00:45:47Z

  tox.ini: Unpin sphinx dependency
  
  https://github.com/rtfd/sphinx_rtd_theme/pull/672 has been fixed
  upstream, and the newer versions of `sphinx_rtd_theme` do not break
  search functionality with Sphinx >= 1.8.
  

• 528e8ed7
  by Chandan Singh at 2019-01-23T01:31:49Z

  Merge branch 'chandan/unpin-sphinx' into 'master'
  
  tox.ini: Unpin sphinx dependency
  
  See merge request BuildStream/buildstream!1093

• 0098a900
  by Tristan Van Berkom at 2019-01-23T13:57:53Z

  tests: Migrated cache quota test into artifactcache/cache_size.py
  
  Instead of sitting mysteriously alone in internals/utils.py
  

• 9be31641
  by Tristan Van Berkom at 2019-01-23T13:57:53Z

  _artifactcache.py: Raise ArtifactError() when quota size exceeds disk space.
  
  This is not an error related to loading data, like a parse error
  in the quota specification is, but a problem raised by the artifact
  cache - this allows us to assert more specific machine readable
  errors in test cases (instead of checking the string in stderr, which
  this patch also fixes).
  
  This also removes a typo from the error message in the said error.
  
    * tests/artifactcache/cache_size.py
  
      Updated test case to expect the artifact error, which consequently
      changes the test case to properly assert a machine readable error
      instead of asserting text in the stderr (which is the real, secret
      motivation behind this patch).
  
    * tests/artifactcache/expiry.py: Reworked test_invalid_cache_quota()
  
      Now expect the artifact error for the tests which check configurations
      which create caches too large to fit on the disk.
  

• 3a6e953f
  by Tristan Van Berkom at 2019-01-24T01:59:13Z

  Merge branch 'tristan/insufficient-storage-error' into 'master'
  
  Tristan/insufficient storage error
  
  See merge request BuildStream/buildstream!1102

• 68339b19
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/testutils/runcli.py: Make get_element_states() take a list of targets
  
  Instead of a single target, we can always provide a single target
  in a list.
  

• 6ecc2b0a
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/artifactcache/expiry.py: Refactored to use get_element_states()
  

• 1140aed5
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/elements/filter.py: Refactored to use get_element_states()
  

• b7ea8b74
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/sources/remote.py: Refactored to use get_element_states()
  

• c2c004f9
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/frontend/pull.py: Refactored to use get_element_states()
  

• 21b2958b
  by Tristan Van Berkom at 2019-01-24T05:01:55Z

  tests/frontend/push.py: Refactored to use get_element_states()
  

• 83fcaa9f
  by Tristan Van Berkom at 2019-01-24T05:01:56Z

  tests/frontend/track.py: Refactored to use get_element_states()
  

• 46eb3018
  by Tristan Van Berkom at 2019-01-24T05:01:56Z

  tests/frontend/workspace.py: Refactored to use get_element_states()
  

• 341b131b
  by Tristan Van Berkom at 2019-01-24T06:13:57Z

  Merge branch 'tristan/test-element-states' into 'master'
  
  Reduce number of calls to `bst show` in tests
  
  See merge request BuildStream/buildstream!1103

• ef2b4648
  by Tristan Van Berkom at 2019-01-24T06:14:20Z

  tests/frontend/track.py: test_track_error_cannot_write_file() fixup
  
  This tests how BuildStream reacts when it fails to write the tracking
  results to the element files or project.refs file, which is an operation
  that plugins do not play a part in.
  
  As such, removing the per repo kind parameterization from this test
  as multiple runs are redundant here.
  

• 40c18174
  by Tristan Van Berkom at 2019-01-24T07:00:50Z

  Merge branch 'tristan/track-test-reduce' into 'master'
  
  test_track_error_cannot_write_file() fixup
  
  See merge request BuildStream/buildstream!1104

• 5b0bba85
  by Jonathan Maw at 2019-01-24T10:15:06Z

  Test that tracking in workspaces actually works
  
  Previously, it merely tested that buildstream did not fall other,
  rather than whether it did anything useful.
  

• 58d7d722
  by Jonathan Maw at 2019-01-24T10:18:01Z

  tests: Test that fetching an open workspace will fetch its dependencies
  
  Previously, there was no way of detecting whether fetching happened, as
  an element with an open workspace will not be fetched.
  

• 24bd8994
  by Jürg Billeter at 2019-01-24T13:36:33Z

  Merge branch 'jonathan/test-missing-workspace-guessing' into 'master'
  
  Add tests to cover reinstated support for guessing targets
  
  See merge request BuildStream/buildstream!1042

• e03dd5fc
  by Jürg Billeter at 2019-01-24T13:37:28Z

  _frontend/cli.py: Guess element also for bst build --all
  
  There is no reason to disallow guess_element() for bst build --all.
  

• 3850274b
  by Phillip Smyth at 2019-01-24T13:37:28Z

  projectconfig.yaml: Add key for default targets
  
  _versions.py: Bump format version
  

• ab72d384
  by Jürg Billeter at 2019-01-24T13:37:28Z

  _project.py: Add get_default_target() and get_default_targets() methods
  
  _frontend/cli.py: Use new methods.
  
  Based on patches by Phillip Smyth.
  

• ee2d8434
  by Jürg Billeter at 2019-01-24T13:37:28Z

  _stream.py: Add ignore_junction_targets parameter
  
  This filters out junctions from the list of targets.
  

• 2f175f0a
  by Jürg Billeter at 2019-01-24T13:37:28Z

  _frontend/cli.py: Ignore junctions in default targets where appropriate
  
  Junctions cannot be built, pulled, or pushed. Specifying a junction on
  the command line for these commands will result in an error. However,
  junctions may be in the list of default targets, so they need to be
  ignored for build, pull, and push commands.
  

• 5a351dee
  by Jürg Billeter at 2019-01-24T13:38:50Z

  format_project.rst: Add documentation for default targets
  

• 77414518
  by Phillip Smyth at 2019-01-24T13:38:50Z

  tests/frontend: Add default target tests for bst show and build
  

• ce1c10ec
  by Jürg Billeter at 2019-01-24T13:38:50Z

  tests/frontend/fetch.py: Add default target test for bst source fetch
  

• 99b5c0af
  by Jürg Billeter at 2019-01-24T13:38:50Z

  tests/frontend/pull.py: Add default target test for bst push/pull
  

• 3642c8e7
  by Jürg Billeter at 2019-01-24T13:38:50Z

  tests/frontend/buildcheckout.py: Add default target test with junction
  
  Test that `bst build` does not fail in a project where the list of
  default targets includes a junction (junctions cannot be built).
  

• 50c5159f
  by Phillip Smyth at 2019-01-24T13:38:50Z

  NEWS: Add entry for default target feature
  

• 05587f22
  by Jürg Billeter at 2019-01-24T15:10:08Z

  Merge branch 'issue-638-validate-all-files' into 'master'
  
  Add support for default targets
  
  See merge request BuildStream/buildstream!925

• 3e36e363
  by Tristan Van Berkom at 2019-01-24T16:55:24Z

  _scheduler/resources.py: Dont error out in unregister_exclusive_interest()
  
  Don't require the interest to be registered, just discard any interest,
  this function just sets a bit in a mask, and is not intended to maintain
  a balance like the reserve() function is.
  

• ce01f87e
  by Tristan Van Berkom at 2019-01-24T16:55:24Z

  _scheduler/scheduler.py: Run cache size exclusively at startup
  
  When running any session that has Queues which require Resource.CACHE,
  check if our loaded estimated size exceeds the quota, and if so;
  lock the Resource.CACHE resource exclusively right away and run
  an exclusive initial cache size job.
  
  This ensures we cleanup first before doing anything which might
  add to the cache at startup time, if deemed needed.
  
  This is a partial fix for issue #737
  

• 2479e8df
  by Tristan Van Berkom at 2019-01-24T16:55:24Z

  _frontend/widget.py: Render core messages more like other messages
  
  In order to test when core activities occur by parsing the stderr
  in tests, we should make the messages conform more.
  
  At the same time, this restores alignment of columns in core
  messages with the element processing related messages.
  
  Also, _scheduler/scheduler.py is updated to make it's activity names
  conform to the (current) 5 character limit for the sake of alignment.
  
  The tests/frontend/logging.py test gets it's regexes updated for
  the log lines it checks for in stderr.
  

• fdb8ff65
  by Tristan Van Berkom at 2019-01-24T16:55:24Z

  tests/artifactcache/expiry.py: Test that expiry happens first
  

• acd0bf22
  by Tristan Van Berkom at 2019-01-24T18:01:41Z

  Merge branch 'tristan/cache-management' into 'master'
  
  Cache management fixes
  
  See merge request BuildStream/buildstream!1091

• 41f03296
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _frontend/app.py: Initialize logging before preflighting the artifact cache
  
  The artifact cache emits messages, and we want to allow that in preflight.
  

• 24ca2f46
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  utils.py: Add _get_volume_size()
  
  We can streamline this call to os.statvfs() in a few places.
  

• 9fd9fbb9
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _artifactcache.py: Refactored to use utils._get_volume_size()
  
  This will benefit from a better UtilError being raised, and
  and turns the artifact cache's local function into a one liner.
  
  The loop which finds the first existing directory in the
  given path has been removed, being meaningless due to the
  call to os.makedirs() in ArtifactCache.__init__().
  
  The local function was renamed to _get_cache_volume_size() and
  no longer takes any arguments, which is more suitable for the
  function as it serves as a testing override surface for
  unittest.mock().
  
  The following test cases which use the function to override
  the ArtifactCache behavior have been updated to use the new
  overridable function name:
  
     tests/artifactcache/cache_size.py
     tests/artifactcache/expiry.py
  

• 7ee0c579
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _artifactcache.py: Added ArtifactCacheUsage()
  
  A simple object which creates a snapshot of current
  usage statistics for easy reporting in the frontend.
  

• 353293b6
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _context.py: Added get_artifact_cache_usage()
  
  A frontend facing API for obtaining usage statistics.
  
  I would have put this on Stream instead, but the Context
  seems to be the de facto place for looking up the artifact cache
  in general so let's put it here.
  

• 51ed36de
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _frontend/widget.py: Added cache usage entry in the startup heading
  

• 5797238b
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _frontend/status.py: Added Cache size usage indicator to status bar
  
  This also adds some comments around the main status bar heading
  rendering function.
  

• 8074ebf4
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _artifactcache.py: Add status messages in cache management operations
  
  Added some useful status messages when:
  
    * Calculating a new artifact cache usage size
  
    * Starting a cleanup
  
    * Finishing a cleanup
  
  Also enhanced messaging about what was cleaned up so far when
  aborting a cleanup.
  

• 49c11bc8
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _artifactcache.py: Added client progress callback to ArtifactCache.clean()
  

• 3616e939
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _scheduler/jobs/job.py: Allow subclasses to message the frontend
  

• bcd19266
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _scheduler/jobs/cleanupjob.py: Update cache size while processing
  
  Updates the known cache size in the main process while the cleanup
  process is ongoing, so that the status indicators update live
  while the cleanup happens.
  

• 9c33107f
  by Tristan Van Berkom at 2019-01-24T18:02:08Z

  _artifactcache.py: Correcting API documenting comment for remove()
  
  This seems to have been copy/pasted from cascache, and
  documents the function to possibly return None if defer_prune
  was specified, but this function does not expose defer_prune.
  

• a2140d74
  by Tristan Van Berkom at 2019-01-24T19:44:52Z

  Merge branch 'tristan/cache-management-logging' into 'master'
  
  Cache management logging enhancements
  
  See merge request BuildStream/buildstream!1105

• d5847462
  by James Ennis at 2019-01-25T16:35:21Z

  _profile.py: Added a new profiling topic, scheduler
  
  profile_start() and profile_end() calls have been incorporated into
  Scheduler.run()
  

• 56a3954c
  by James Ennis at 2019-01-25T16:35:21Z

  _profile.py: Added a new profiling topic, load-selection
  
  profile_start() and profile_end() calls have been added to
  Stream.load_selection()
  

• 116da6d7
  by James Ennis at 2019-01-25T16:35:21Z

  _profile.py: Update copyright statement
  

• 137d31cd
  by James Ennis at 2019-01-25T17:59:22Z

  Merge branch 'jennis/add_new_profile_topic' into 'master'
  
  Add new 'scheduler' and 'load-selection' profiling topics
  
  See merge request BuildStream/buildstream!1088

• 22b3a0c1
  by Tristan Van Berkom at 2019-01-25T18:35:36Z

  _artifactcache.py: Don't require the quota to be available on disk.
  
  Instead only rely on the headroom to be enough to protect against
  out of space conditions. The headroom can become configurable as
  a separate step is required.
  
  The changes to achieve this are:
  
    * Rename ArtifactCache.has_quota_exceeded() to ArtifactCache.full().
  
    * ArtifactCache.full() now also reports True if the available
      space on the artifact cache volume is smaller than the headroom.
  
      This ensures jobs get triggered to cleanup the cache when
      reaching the end of the disk.
  
    * When loading the artifact quota, it is now only an error if
      the quota exceeds the overall disk space, not if it does not
      fit in the available space.
  
      It is still a warning if the quota does not fit in the
      available space on the artifact cache volume.
  
    * Updated scheduler.py and buildqueue.py for the API rename
  
    * tests: Updated the artifactcache/expiry.py test for its
      expectations in this regard.
  
      Added a new test to test an error when quota was specified to
      exceed total disk space, and adjusted the existing tests to
      expect a warning when the quota does not fit in the available
      space.
  
  This fixes issue #733 and #869.
  

• 27ca6cc7
  by Tristan Van Berkom at 2019-01-25T21:18:15Z

  Merge branch 'tristan/cache-quota-max-only' into 'master'
  
  _artifactcache.py: Don't require the quota to be available on disk.
  
  Closes #869 and #733
  
  See merge request BuildStream/buildstream!1106

• 89ba2abe
  by Chandan Singh at 2019-01-25T23:50:49Z

  tox.ini: Add environment to update man pages
  
  Previously, one had to manually install `click-man` package, and
  remember to run the correct command. Now, we can simply run `tox -e man`
  to update the man pages.
  

• d7438688
  by Chandan Singh at 2019-01-25T23:50:49Z

  man: Refresh man pages
  
  Notable changes:
  
  * New `source` and `artifact` command groups
  * Man pages corresponding to obsolete commands, that were marked as
    hidden in Click, have now been removed.
  
  Fixes #881.
  

• 4edbbd27
  by Chandan Singh at 2019-01-25T23:50:49Z

  setup.py, CONTRIBUTING.rst: Recommend using tox to generate man pages
  
  Simplify our docs, by requesting users to run `tox -e man` to update man
  pages, instead of manually installing `click-man` and running the
  command manually.
  

• a3e7aee8
  by Chandan Singh at 2019-01-25T23:50:49Z

  setup.py: Do not error out when man directory is empty/missing
  
  If the `man` directory is empty, then it won't be copied in the source
  distribution, and `list_man_pages()` will throw an exception when trying
  to list files in a non-existent directory. This prevents us from
  installing the BuildStream package when the man pages are not there.
  
  The most common use-case for this is when we want to re-generate the man
  pages but want to install the package before re-generating them.
  

• 222753ac
  by Tristan Van Berkom at 2019-01-26T05:10:36Z

  Merge branch 'chandan/toxic-man' into 'master'
  
  Generate man pages using tox & update them
  
  Closes #880 and #881
  
  See merge request BuildStream/buildstream!1107

• e3a27310
  by Valentin David at 2019-01-28T09:13:28Z

  Fix crash when spawned job completes very fast
  
  Job can complete before we return from `Job.span()` to
  `Scheduler._spawn_job()`, so that `_active_jobs` would not yet contain
  the job.
  
  This would print a stack on the console and try to run a second time
  the job which can have unexpected effects.
  
  In order to reproduce the issue, in
  `buildstream/_scheduler/jobs/job.py`, in `Job.spawn`,
  add a call to `time.sleep()` right before call to
  `asyncio.get_child_watcher()`.
  
  This fixes issue #857.
  

30 changed files:

• CONTRIBUTING.rst
• NEWS
• buildstream/_artifactcache.py
• buildstream/_context.py
• buildstream/_frontend/app.py
• buildstream/_frontend/cli.py
• buildstream/_frontend/status.py
• buildstream/_frontend/widget.py
• buildstream/_profile.py
• buildstream/_project.py
• buildstream/_scheduler/jobs/cleanupjob.py
• buildstream/_scheduler/jobs/job.py
• buildstream/_scheduler/queues/buildqueue.py
• buildstream/_scheduler/queues/queue.py
• buildstream/_scheduler/resources.py
• buildstream/_scheduler/scheduler.py
• buildstream/_stream.py
• buildstream/_versions.py
• buildstream/data/projectconfig.yaml
• buildstream/element.py
• buildstream/source.py
• buildstream/utils.py
• contrib/bst-docker-import
• doc/source/arch_remote_execution.rst
• doc/source/format_project.rst
• doc/source/tutorial/first-project.rst
• doc/source/using_commands.rst
• doc/source/using_configuring_artifact_server.rst
• man/bst-checkout.1 → man/bst-artifact-checkout.1
• + man/bst-artifact-log.1

The diff was not included because it is too large.

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.