BobBuildTool 1.2.0__tar.gz → 1.3.0__tar.gz

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/.github/workflows/workflow.yaml

@@ -37,7 +37,7 @@ jobs:
               run: |
                 python -m pip install --upgrade pip
                 python -m pip install --upgrade setuptools
-                pip install PyYAML coverage schema python-magic pyparsing sphinx wheel
+                pip install PyYAML coverage schema python-magic pyparsing sphinx wheel build
                 sudo apt-get update
                 sudo apt-get install cvs subversion
 
@@ -50,7 +50,9 @@ jobs:
 
             - name: Build Python package
               run: |
-                python3 setup.py bdist_wheel --plat-name manylinux1_x86_64
+                python3 -m build --wheel -C--build-option=--plat-name=manylinux1_x86_64
+                # make sure setuptools-scm did run
+                test -f pym/bob/version.py
 
             - name: Upload coverage to Codecov
               uses: codecov/codecov-action@v4
@@ -99,6 +101,7 @@ jobs:
 
             - name: Run unit tests
               run: |
+                Set-MpPreference -DisableRealtimeMonitoring $true
                 git config --global init.defaultBranch master # keep the old name
                 git config --global protocol.file.allow always # roll back CVE-2022-39253
                 $env:PATH = "$env:PATH;C:\msys64\usr\bin"
@@ -126,11 +129,13 @@ jobs:
               run: |
                 python -m pip install --upgrade pip
                 python -m pip install --upgrade setuptools
-                pip install PyYAML schema python-magic pyparsing sphinx wheel
+                pip install PyYAML schema python-magic pyparsing sphinx wheel build
 
             - name: Build Python package
               run: |
-                python3 setup.py sdist
+                python3 -m build --sdist
+                # make sure setuptools-scm did run
+                test -f pym/bob/version.py
 
             - name: Store the source distribution
               uses: actions/upload-artifact@v4

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BobBuildTool
-Version: 1.2.0
+Version: 1.3.0
 Summary: Functional cross platform build-automation tool
 Home-page: https://bobbuildtool.github.io/
 Download-URL: https://github.com/BobBuildTool/bob/releases

bobbuildtool-1.3.0/contrib/plugins/command.py

@@ -0,0 +1,25 @@
+# Sample plugin that adds a new top level command: 'bob hello'
+#
+# Run e.g. 'bob hello root' to print the path of all matching packages.
+
+import argparse
+
+def doHello(packages, argv, bobRoot):
+    parser = argparse.ArgumentParser(prog="bob hello",
+        description="Print the path of all matching packages.")
+    parser.add_argument('package', nargs='?', default="",
+        help="Package to query (defaults to all root packages)")
+    args = parser.parse_args(argv)
+
+    for (stack, node) in packages.queryTreePath(args.package):
+        print("/".join(stack) if stack else "/")
+
+manifest = {
+    'apiVersion' : "1.2.1.dev1",
+    'commands' : {
+        'hello' : {
+            'func' : doHello,
+            'help' : "Print all package paths",
+        },
+    },
+}

bobbuildtool-1.3.0/doc/glossary.rst

@@ -0,0 +1,72 @@
+Glossary
+========
+
+.. glossary::
+
+   Variant-Id
+        Describes *how* a particular :term:`Step` of a :term:`Package` is
+        built. This includes all scripts, environment variables and recursive
+        dependencies. See :ref:`concepts-implicit-versioning`.
+
+   Build-Id
+        Describes *what* is actually being built. This takes into account the
+        actual sources of the checkout step, the build- and package-step scripts
+        and recursively all depenencies. It identifies the (expected) build
+        result and is used as index key of binary artifacts. See
+        :ref:`concepts-implicit-versioning`.
+
+   Recipe
+        Yaml file holding the blueprint of what packages are built. Can inherit
+        from :term:`classes <Class>` to reduce redundancy. When parsing the
+        recipe graph one or more :term:`packages <Package>` are created from a
+        single recipe.
+
+   Package
+        Particular instance of a recipe after resolving all inputs of the recipe
+        (environment, tools, sandbox) and all dependencies.
+
+   Class
+        Syntactically the same as a recipe. Used to factor out common parts
+        of recipes to remove redundancy.
+
+   Step
+        One of the three individual build steps of a recipe/package that are
+        defined in Bob: checkout-, build- and package-step.
+
+   Package-Id
+        Describes *how* a :term:`Package` is built. Identical to the
+        :term:`Variant-Id` of the package :term:`Step`.
+
+   Upstream
+        Relative direction in the dependency graph towards the dependencies of
+        a recipe. The dependencies of a recipe are its upstream recipes.
+
+   Downstream
+        Relative direction in the dependency graph towards the consumers of a
+        recipe. The recipes that depend on a recipe are its downstream recipes.
+
+   Declared dependency
+        A dependency that is explicitly named in the
+        :ref:`configuration-recipes-depends` section of a recipe. Also called
+        *direct* dependency. See :ref:`configuration-principle-dependencies`.
+
+   Provided dependency
+        A dependency that a recipe offers to its :term:`downstream <Downstream>`
+        recipes by listing it in :ref:`configuration-recipes-providedeps`.
+        Always refers to the providing side. See
+        :ref:`configuration-principle-dependencies`.
+
+   Injected dependency
+        A dependency that a recipe receives because it was provided by one of
+        its :term:`declared dependencies <Declared dependency>`. It is not named
+        in the receiving recipe. See
+        :ref:`configuration-principle-dependencies`.
+
+   Ambient dependency
+        A tool, sandbox or interpreter that a recipe inherits from its
+        :term:`downstream <Downstream>` recipes. See
+        :ref:`configuration-principle-dependencies`.
+
+   Transitive dependency
+        A package that is reachable by recursively following the dependencies
+        of a package. See :ref:`configuration-principle-dependencies`.

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manpages/bob-clean.rst

@@ -15,9 +15,10 @@ Synopsis
 
 ::
 
-    bob clean [-h] [--develop | --release | --attic | --shared]
-              [-c CONFIGFILE] [-D DEFINES] [--dry-run] [-f] [-s]
-              [--all-unused] [--used] [--sandbox | --no-sandbox] [-v]
+    bob clean [-h] [--develop | --release | --attic | --shared] [--dry-run]
+              [-f] [-s] [--all-unused] [--used] [-D DEFINES]
+              [-c CONFIGFILE] [--sandbox | --slim-sandbox | --dev-sandbox |
+              --strict-sandbox | --no-sandbox] [-v]
 
 
 Description
@@ -68,6 +69,12 @@ Options
 ``--attic``
     Remove attic directories.
 
+``--dev-sandbox``
+    Enable development sandboxing.
+
+``--no-sandbox``
+    Disable sandboxing
+
 ``--shared``
     Delete packages from shared location.
 
@@ -97,6 +104,15 @@ Options
        are actually deleted. While Bob can check SCMs that it knows it cannot
        detect all modifications, e.g. changes to extracted tar files.
 
+``--sandbox``
+    Enable partial sandboxing.
+
+``--slim-sandbox``
+    Enable slim sandboxing.
+
+``--strict-sandbox``
+    Enable strict sandboxing.
+
 ``--used``
     If a package is still used by a project on the machine it is not deleted by
     default even if the quota is still exceeded. By giving this option such

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manpages/bob-ls-recipes.rst

@@ -72,4 +72,4 @@ Options
 
 ``--used``
     List all used recipes. These are recipes that are referenced directly or
-    indirectly by a root package.
+    transitively by a root package.

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manpages/bob-ls.rst

@@ -27,19 +27,22 @@ List package dependencies. The optional ``package`` argument specifies what
 package(s) should be listed. If no package is specified the virtual root
 package is used, thus printing all top level packages and aliases. The ``/``
 package path selects the virtual root package too but does not list aliases as
-it is a absolute location path. See :ref:`bobpaths(7) <manpage-bobpaths>` for
+it is an absolute location path. See :ref:`bobpaths(7) <manpage-bobpaths>` for
 how to specify packages and how aliases are handled.
 
-By default only the direct dependencies of the package are displayed. By adding
-``-a`` the indirect dependencies (i.e. dependencies collected from
-:ref:`provideDeps <configuration-recipes-providedeps>`) are displayed too. To
-see the relative path from where the indirect dependencies were inherited add
-``-o``.
+By default only the declared dependencies of the package are displayed. By
+adding ``-a`` the injected dependencies (i.e. dependencies provided by its
+declared dependencies through :ref:`provideDeps
+<configuration-recipes-providedeps>`) are displayed too. To see the relative
+path from where the injected dependencies originate add ``-o``. See
+:ref:`configuration-principle-dependencies` for the definition of these terms.
 
 Without any further options only the first level of dependencies is listed.
-Adding ``-r`` shows a graphical tree of all transitive dependencies too. To get
-a list of all transitive dependencies instead, specify ``-p``. This will print
-each package on a separate line with the full package path. The aliases listed
+Adding ``-r`` shows a graphical tree of all transitive dependencies too.
+Recursion follows the same dependencies that are displayed, i.e. only declared
+dependencies unless ``-a`` is given. Adding ``-p`` prints each package on a
+separate line with the full package path instead of the tree. Combined with
+``-r`` this lists all transitive dependencies. The aliases listed
 below the virtual root package are not recursively traversed as they can
 involve arbitrarily complex queries. If you want to recursively list the
 dependencies of an alias you have to specify it explicitly as ``package``
@@ -52,14 +55,14 @@ cannot be used in conjunction with the ``-p`` option and ignores further ``-a``,
 ``-o`` and ``-r`` options.
 
 To see *every* package selected by the query, add ``-A``. This will print all
-alternate paths to identical packages. This affects only the ``d`` and ``-p``
+alternate paths to identical packages. This affects only the ``-d`` and ``-p``
 options, because the path leading to the selected packages is significant.
 
 Options
 -------
 
 ``-a, --all``
-    Show indirect dependencies too. By default only direct dependencies (i.e.
+    Show injected dependencies too. By default only declared dependencies (i.e.
     dependencies explicitly specified in the recipe) are displayed.
 
 ``-A, --alternates``
@@ -87,12 +90,12 @@ Options
     Disable sandboxing
 
 ``-o, --origin``
-    Show origin of indirect dependencies. This is printed as relative path to
+    Show origin of injected dependencies. This is printed as relative path to
     the current package.
 
 ``-p, --prefixed``
-    Prints the full path prefix for each package. Without this option a
-    graphical tree of the dependencies is displayed.
+    Prints the full path prefix for each package. Without this option, a
+    graphical tree of the dependencies is displayed when ``-r`` is given.
 
 ``-r, --recursive``
     Recursively display dependencies

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manpages/bob-status.rst

@@ -15,10 +15,11 @@ Synopsis
 
 ::
 
-    bob status [-h] [--develop | --release] [-c CONFIGFILE] [-D DEFINES]
-               [--attic] [-r] [--sandbox | --no-sandbox] [--show-clean]
-               [--show-overrides] [-v]
-               [packages [packages ...]]
+    bob status [-h] [--develop | --release] [--attic] [-r] [-D DEFINES]
+               [-c CONFIGFILE] [--sandbox | --slim-sandbox |
+               --dev-sandbox | --strict-sandbox | --no-sandbox]
+               [--show-clean] [--show-overrides] [-v]
+               [packages ...]
 
 Description
 -----------
@@ -55,20 +56,29 @@ Options
 ``--develop``
     Use developer mode. This is the default.
 
+``--dev-sandbox``
+    Enable development sandboxing.
+
 ``--no-sandbox``
     Disable sandboxing
 
 ``-r, --recursive``
-    Recursively display dependencies. Only direct dependencies are considered,
-    i.e. packages that are named in the ``depends`` section of the recipe.
-    Consumed tool- and sandbox- packages that were forwarded are thus not
-    visited.
+    Recursively display dependencies. Only declared dependencies are
+    considered, i.e. packages that are named in the ``depends`` section of the
+    recipe. Injected dependencies as well as ambient tool-, sandbox- and
+    interpreter-packages are thus not visited.
 
 ``--release``
     Use release mode.
 
 ``--sandbox``
-    Enable sandboxing
+    Enable partial sandboxing.
+
+``--slim-sandbox``
+    Enable slim sandboxing.
+
+``--strict-sandbox``
+    Enable strict sandboxing.
 
 ``--show-clean``
     Show the status of a checkout even if unmodified. This includes

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manpages/bobpaths.rst

@@ -30,7 +30,9 @@ Examples:
 When Bob parses the recipes he builds an internal package graph. The general
 dependency structure is derived from the recipes. Depending on the actual
 content one or more packages are generated from a recipe. The Bob queries are
-working on the package graph.
+working on the package graph. Ambient dependencies (tools, sandbox and
+interpreters) that a package inherits from its downstream recipes are not part
+of its children in the package graph.
 
 The primary constructs of Bob paths are the location path and predicate
 expressions. Both are evaluated with respect to a context which consists of:
@@ -53,7 +55,7 @@ stays constant throughout the whole evaluation.
 
 A path is parsed by first dividing the character string into tokens and then
 parsing the resulting sequence of tokens. Whitespaces are ignored between
-tokens and may be freely injected. Some tokes (e.g. ``*``,  ``[`` or ``]``)
+tokens and may be freely injected. Some tokens (e.g. ``*``,  ``[`` or ``]``)
 collide with special characters of the shell. Care should be taken to correctly
 quote or escape these characters when invoking Bob from the command line.
 
@@ -84,7 +86,7 @@ All examples above are abbreviations of the verbose syntax. See the following
 examples for the full syntax:
 
 * ``child@foo`` selects the ``foo`` child package of the context package
-* ``chils@f*`` selects all children of the context package starting with ``f``
+* ``child@f*`` selects all children of the context package starting with ``f``
 * ``/child@foo/child@bar`` selects the ``bar`` child of the ``foo`` top level
   package
 * ``descendant@foo`` selects the ``foo`` descendants of the context package
@@ -100,11 +102,11 @@ examples for the full syntax:
 * ``child@*["${LICENSE}" == "GPLv2"]`` selects all children of the context package
   that are licensed as GPLv2
 * ``child@lib*[child@libc]`` selects the children starting with ``lib`` of the
-  context package that have a ``libc`` child (i.e. that have a dependency to
-  ``libc``)
+  context package that have a ``libc`` child (i.e. that have a declared or
+  injected dependency to ``libc``)
 * ``descendant-or-self@lib*["${LICENSE}" == "GPLv2" && child@libc]`` selects
-  the context package or any of it descendants that start with ``lib`` which
-  are licensed as GPLv2 and have a direct dependency to ``libc``
+  the context package or any of its descendants that start with ``lib`` which
+  are licensed as GPLv2 and have a declared or injected dependency to ``libc``
 
 There are two kinds of location path: relative location paths and absolute
 location paths.
@@ -137,17 +139,21 @@ Location steps
     The syntax for a location step is ``axis@name[predicate]``.
 
 Axis specifier
-    The following axis are available:
+    The following axes are available:
 
     * the ``self`` axis contains just the context package itself,
-    * the ``child`` axis contains all children of the context package,
+    * the ``child`` axis contains all children of the context package (i.e.
+      its declared and injected dependencies),
     * the ``direct-child`` axis contains the direct children of the context
-      package (i.e. without provided dependencies),
+      package (i.e. only its declared dependencies without injected
+      dependencies),
     * the ``descendant`` axis contains all descendants of the context package;
-      a descendant is a child or a child of a child and so on,
+      a descendant is a child or a child of a child and so on (i.e. its
+      transitive dependencies following declared and injected dependencies),
     * the ``direct-descendant`` axis contains the direct descendants of the
       context package; a direct descendant is a direct child or a direct child
-      of a direct child and so on,
+      of a direct child and so on (i.e. its transitive dependencies following
+      only declared dependencies),
     * the ``descendant-or-self`` axis contains the context package and the
       descendants of the context package
     * the ``direct-descendant-or-self`` axis contains the context package and
@@ -247,7 +253,7 @@ String literals
 String function calls
 ~~~~~~~~~~~~~~~~~~~~~
     String functions may be called directly without relying on string
-    substitution.  The general syntax is the funcion name, an opening
+    substitution.  The general syntax is the function name, an opening
     parenthesis, zero or more arguments separated by comma and a closing
     parenthesis.
 
@@ -278,10 +284,11 @@ Operator Associativity Operand type       Meaning
 
 See the following examples for some complex expressions:
 
-* ``"${FOO}" == "bar"`` selects packages which use variable ``FOO`` an where
+* ``"${FOO}" == "bar"`` selects packages which use variable ``FOO`` and where
   the value is ``bar``
 * ``!match("${LICENSE}", "GPL") && *[ match("${LICENSE}", "GPL") ]`` selects
-  packages that are *not* GPL-licensed and depend on a GPL-licensed package
+  packages that are *not* GPL-licensed and have a declared or injected
+  dependency to a GPL-licensed package
 
 .. _manpage-bobpaths-aliases:
 
@@ -302,7 +309,7 @@ Example definitions::
       allTests: "//*-unittest"
       myAppDeps: "myApp/*"
 
-Given the definitions above the following substations will be performed:
+Given the definitions above the following substitutions will be performed:
 
 ======================= ===========================
 Query                   Substituted query

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manual/audit-trail.rst

@@ -115,8 +115,11 @@ Basic information
 ``env``
     Dump of the bash environment as created by ``declare -p``. See
     `bash declare`_. For PowerShell recipes it is a JSON string that contains
-    all internal variables and environment variables as dictionaries. Use
-    the ``meta.language`` key to determine the used scripting language.
+    all internal variables and environment variables as dictionaries. For
+    Python recipes it is the ``repr()`` of a dictionary with the ``env`` and
+    ``globals`` keys holding the environment variables and global variables
+    respectively. Use the ``meta.language`` key to determine the used scripting
+    language.
 
 ``metaEnv``
     This is a dictionary of all :ref:`configuration-recipes-metaenv` variables
@@ -234,9 +237,9 @@ under the ``meta`` key and typically hold at least the following information:
     Bob version string.
 
 ``language``
-   The scripting language that was used to create the artifact. Can be ``bash``
-   or ``PowerShell``. If missing it must be interpreted as ``bash``. Use this to
-   correctly parse the ``env`` string.
+   The scripting language that was used to create the artifact. Can be ``bash``,
+   ``PowerShell`` or ``python``. If missing it must be interpreted as ``bash``.
+   Use this to correctly parse the ``env`` string.
 
 ``package``
     Package path of the artifact that was built. Note that there might be

{bobbuildtool-1.2.0 → bobbuildtool-1.3.0}/doc/manual/concepts.rst

@@ -27,8 +27,9 @@ with downstream and upstream recipes:
 There are four kinds of objects that are exchanged between recipes: results,
 dependencies, environment variables and tools. Results (shown as black arrows)
 are always propagated downstream. These are the actual build artifacts that are
-created. Dependencies (upstream recipes) may be propagated downstream which is
-not shown in the picture. Environment variables are key-value-pairs of
+created. Dependencies (upstream recipes) may be provided to downstream recipes
+where they become injected dependencies. This is not shown in the picture.
+Environment variables are key-value-pairs of
 strings. They are passed as shell variables to the individual build steps.
 Tools are scripts or executables that are needed to produce the build result,
 e.g. compilers, image generators or post processing scripts. Consuming recipes