[Notes] [Git][BuildStream/buildstream][chandan/pip-install-instructions]

Tristan Van Berkom pushed to branch chandan/pip-install-instructions at BuildStream / buildstream

Commits:

56096b60

by Chandan Singh at 2018-08-24T02:12:03Z

.gitlab-ci.yml: Verify that source tarball installs correctly

Add a check to verify that the source distribution tarball that we
generate installs corrctly. It is useful to do this check as this is the
same tarball will be used when installing BuildStream via PyPI.

This check also happens indirectly in the coverage job where we install
BuildStream but this check makes it more explicit and will also cause
the CI to fail early if the tarball is not correct.

86e4729d

by Tristan Van Berkom at 2018-08-24T06:42:03Z

Merge branch 'chandan/ci-sdist-test' into 'master'

.gitlab-ci.yml: Verify that source tarball installs correctly

See merge request BuildStream/buildstream!720

d88568ef

by Valentin David at 2018-08-24T06:48:08Z

tests/integration/source-determinism.py: Use cli_integration.

f7ef151b

by Tristan Van Berkom at 2018-08-24T07:36:19Z

Merge branch 'valentindavid/cli_integration_source_determinism' into 'master'

tests/integration/source-determinism.py: Use cli_integration.

See merge request BuildStream/buildstream!715

fa476d79

by Tristan Van Berkom at 2018-08-24T07:55:43Z

tests/integration/project: Use the same alias for the alpine tarball

This makes the integration tests use the same 'alpine' alias for the
tests as we use in the examples, this avoids a redundant download
of an extra alpine tarball in integration tests.

This is a part of #603

255f9ee3

by Tristan Van Berkom at 2018-08-24T08:39:19Z

Merge branch 'tristan/avoid-redundant-alpine' into 'master'

tests/integration/project: Use the same alias for the alpine tarball

See merge request BuildStream/buildstream!722

5bd6f762

by Chandan Singh at 2018-08-24T10:20:18Z

doc: Add instructions to install BuildStream via PyPI

Add instructions to install and update BuildStream python package via
PyPI, and also make it the recommended method.

Part of https://gitlab.com/BuildStream/buildstream/issues/587.

6 changed files:

.gitlab-ci.yml
doc/source/install_linux_distro.rst
tests/integration/project/elements/base/base-alpine.bst
tests/integration/project/project.conf
tests/integration/source-determinism.py
tests/testutils/runcli.py

Changes:

.gitlab-ci.yml

@@ -36,6 +36,11 @@ source_dist:
    - tar -ztf dist/*
    - tarball=$(cd dist && echo $(ls *))
 +  # Verify that the source distribution tarball can be installed correctly
 +  #
 +  - pip3 install dist/*.tar.gz
 +  - bst --version
++
    # unpack tarball as `dist/buildstream` directory
    - |
      cat > dist/unpack.sh << EOF

doc/source/install_linux_distro.rst

@@ -152,8 +152,29 @@ for advice on this.
  Installing
  ~~~~~~~~~~
 -Once you have the base system dependencies, you can clone the BuildStream
 -git repository and install it as a regular user::
 +Once you have the base system dependencies, you can install the BuildStream
 +python package as a regular user.
++
 +Via PyPI (recommended)
 +++++++++++++++++++++++
 +::
++
 +  pip3 install --user BuildStream
++
 +This will install latest stable version of BuildStream and its pure python
 +dependencies into your user's homedir in ``~/.local``.
++
 +Keep following the instructions below to ensure that the ``bst``
 +command is in your ``PATH`` and to enable bash completions for it.
++
 +.. note::
++
 +  If you want a specific version of BuildStream, you can install it using
 +  ``pip install --user BuildStream==<version-number>``
++
 +Via Git checkout
 +++++++++++++++++
 +::
    git clone https://gitlab.com/BuildStream/buildstream.git
    cd buildstream
@@ -206,9 +227,19 @@ to your ``~/.bash_completion``:
  Upgrading BuildStream
  ~~~~~~~~~~~~~~~~~~~~~
 -Assuming you have followed the default instructions above, all
 -you need to do to upgrade BuildStream is to update your local git
 -checkout::
++
 +Via PyPI
 +++++++++
++
 +If you installed BuildStream from PyPI, you can update it like so::
++
 +  pip install --user --upgrade BuildStream
++
 +Via Git checkout
 +++++++++++++++++
++
 +If you installed BuildStream from a local git checkout using ``-e`` option, all
 +you need to do to upgrade BuildStream is to update your local git checkout::
    cd /path/to/buildstream
    git pull --rebase

tests/integration/project/elements/base/base-alpine.bst

@@ -7,6 +7,6 @@ description: |
  sources:
    - kind: tar
 -    url: sysroot:tarballs/integration-tests-base.v1.x86_64.tar.xz
 +    url: alpine:integration-tests-base.v1.x86_64.tar.xz
      base-dir: ''
      ref: 3eb559250ba82b64a68d86d0636a6b127aa5f6d25d3601a79f79214dc9703639

tests/integration/project/project.conf

@@ -2,7 +2,7 @@
  name: test
  element-path: elements
  aliases:
 -  sysroot: https://gnome7.codethink.co.uk/
 +  alpine: https://gnome7.codethink.co.uk/tarballs/
    project_dir: file://{project_dir}
  options:
    linux:

tests/integration/source-determinism.py

@@ -2,7 +2,8 @@ import os
  import pytest
  from buildstream import _yaml, utils
 -from tests.testutils import cli, create_repo, ALL_REPO_KINDS
 +from tests.testutils import create_repo, ALL_REPO_KINDS
 +from tests.testutils import cli_integration as cli
  DATA_DIR = os.path.join(
@@ -28,7 +29,7 @@ def create_test_directory(*path, mode=0o644):
  @pytest.mark.integration
  @pytest.mark.datafiles(DATA_DIR)
  @pytest.mark.parametrize("kind", [(kind) for kind in ALL_REPO_KINDS] + ['local'])
 -def test_deterministic_source_umask(cli, tmpdir, datafiles, kind):
 +def test_deterministic_source_umask(cli, tmpdir, datafiles, kind, integration_cache):
      project = str(datafiles)
      element_name = 'list'
      element_path = os.path.join(project, 'elements', element_name)
@@ -91,14 +92,16 @@ def test_deterministic_source_umask(cli, tmpdir, datafiles, kind):
                  return f.read()
          finally:
              os.umask(old_umask)
 -            cli.remove_artifact_from_cache(project, element_name)
 +            cache_dir = os.path.join(integration_cache, 'artifacts')
 +            cli.remove_artifact_from_cache(project, element_name,
 +                                           cache_dir=cache_dir)
      assert get_value_for_umask(0o022) == get_value_for_umask(0o077)
  @pytest.mark.integration
  @pytest.mark.datafiles(DATA_DIR)
 -def test_deterministic_source_local(cli, tmpdir, datafiles):
 +def test_deterministic_source_local(cli, tmpdir, datafiles, integration_cache):
      """Only user rights should be considered for local source.
      """
      project = str(datafiles)
@@ -150,6 +153,8 @@ def test_deterministic_source_local(cli, tmpdir, datafiles):
              with open(os.path.join(checkoutdir, 'ls-l'), 'r') as f:
                  return f.read()
          finally:
 -            cli.remove_artifact_from_cache(project, element_name)
 +            cache_dir = os.path.join(integration_cache, 'artifacts')
 +            cli.remove_artifact_from_cache(project, element_name,
 +                                           cache_dir=cache_dir)
      assert get_value_for_mask(0o7777) == get_value_for_mask(0o0700)

tests/testutils/runcli.py

@@ -198,8 +198,10 @@ class Cli():
          for key, val in config.items():
              self.config[key] = val
 -    def remove_artifact_from_cache(self, project, element_name):
 -        cache_dir = os.path.join(project, 'cache', 'artifacts')
 +    def remove_artifact_from_cache(self, project, element_name,
 +                                   *, cache_dir=None):
 +        if not cache_dir:
 +            cache_dir = os.path.join(project, 'cache', 'artifacts')
          cache_dir = os.path.join(cache_dir, 'cas', 'refs', 'heads')

[Notes] [Git][BuildStream/buildstream][chandan/pip-install-instructions] 7 commits: .gitlab-ci.yml: Verify that source tarball installs correctly

Tristan Van Berkom pushed to branch chandan/pip-install-instructions at BuildStream / buildstream

Commits:

6 changed files:

Changes: