Artifact splitting tests
========================

Parsing and validation
----------------------

To verify that the products fields are parsed correctly, we have a
scenario that uses all of them, not relying on the default rules.

    SCENARIO building a system with morphologies that have splitting rules
    GIVEN a workspace
    AND a git server

To test that all the fields are recognised, we set the new fields to
their default values.

    AND chunk test-chunk includes the default splitting rules
    AND stratum test-stratum includes the default splitting rules
    AND system test-system includes the default splitting rules

The default rules produce a system that is identical to not providing
them, and since this test is about validation, we don't care about the
result, so much as it succeeding to build something.

    WHEN the user checks out the system branch called master
    THEN morph build the system test-system of the branch master

Smaller systems
---------------

An example use-case for splitting is to only include the runtime
strata for a target system, rather than including all the development
information, such as the documentation, C library headers and C static
libraries.

    SCENARIO building a system only using runtime strata
    GIVEN a workspace
    AND a git server

The only change we need to make is to add a field to the system morphology
to select which artifact to use in the system.

    AND system test-system uses test-stratum-runtime from test-stratum
    WHEN the user checks out the system branch called master

The best way to test that only using some stratum artifacts works is
to check which files the output has, so we deploy a tarball and inspect
its contents.

    GIVEN a cluster called test-cluster in system branch master
    AND a system in cluster test-cluster in branch master called test-system
    AND system test-system in cluster test-cluster in branch master builds test-system
    AND system test-system in cluster test-cluster in branch master has deployment type: tar
    WHEN the user builds the system test-system in branch master
    AND the user attempts to deploy the cluster test-cluster in branch master with options test-system.location="$DATADIR/test.tar"

The -runtime artifacts include executables and shared libraries.

    THEN tarball test.tar contains bin/test
    AND tarball test.tar contains lib/libtest.so

The -devel artifacts include static libraries and documentation, so if
we've successfully excluded it, we won't have those files.

    AND tarball test.tar doesn't contain lib/libtest.a
    AND tarball test.tar doesn't contain man/man3/test.3.gz

As a consequence of how dependencies are generated, if we select strata
to go into our system, such that there are chunk artifacts that are not
needed, then they don't get built.

    SCENARIO building a system that has unused chunks
    GIVEN a workspace
    AND a git server

This GIVEN has a chunk in the stratum that never successfully builds,
so we know that if the system successfully builds, then we only built
chunks that were needed.

    AND stratum test-stratum has chunks that aren't used in test-stratum-minimal
    AND system test-system uses test-stratum-minimal from test-stratum
    WHEN the user checks out the system branch called master
    THEN morph build the system test-system of the branch master


Implementations
---------------

    IMPLEMENTS GIVEN chunk (\S+) includes the default splitting rules
    # Append default products rules
    cat <<EOF >>"$DATADIR/gits/$MATCH_1/$MATCH_1.morph"
    products:
    - artifact: $MATCH_1-bins
      include: [ "(usr/)?s?bin/.*" ]
    - artifact: $MATCH_1-libs
      include:
      - (usr/)?lib(32|64)?/lib[^/]*\.so(\.\d+)*
      - (usr/)?libexec/.*
    - artifact: $MATCH_1-devel
      include:
      - (usr/)?include/.*
      - (usr/)?lib(32|64)?/lib.*\.a
      - (usr/)?lib(32|64)?/lib.*\.la
      - (usr/)?(lib(32|64)?|share)/pkgconfig/.*\.pc
    - artifact: $MATCH_1-doc
      include:
      - (usr/)?share/doc/.*
      - (usr/)?share/man/.*
      - (usr/)?share/info/.*
    - artifact: $MATCH_1-locale
      include:
      - (usr/)?share/locale/.*
      - (usr/)?share/i18n/.*
      - (usr/)?share/zoneinfo/.*
    - artifact: $MATCH_1-misc
      include: [ .* ]
    EOF
    run_in "$DATADIR/gits/$MATCH_1" git add "$MATCH_1.morph"
    run_in "$DATADIR/gits/$MATCH_1" git commit -m 'Add default splitting rules'

    IMPLEMENTS GIVEN stratum (\S+) includes the default splitting rules
    # Append default products rules
    cat <<EOF >"$DATADIR/gits/morphs/$MATCH_1.morph"
    name: $MATCH_1
    kind: stratum
    products:
    - artifact: $MATCH_1-devel
      include:
      - .*-devel
      - .*-debug
      - .*-doc
    - artifact: $MATCH_1-runtime
      include:
      - .*-bins
      - .*-libs
      - .*-locale
      - .*-misc
      - .*
    chunks:
    -   name: test-chunk
        repo: test:test-chunk
        ref: master
        morph: test-chunk
        build-mode: test
        build-depends: []
        artifacts:
            test-chunk-bins: $MATCH_1-runtime
            test-chunk-libs: $MATCH_1-runtime
            test-chunk-locale: $MATCH_1-runtime
            test-chunk-misc: $MATCH_1-runtime
            test-chunk-devel: $MATCH_1-devel
            test-chunk-doc: $MATCH_1-devel
    EOF
    run_in "$DATADIR/gits/morphs" git add "$MATCH_1.morph"
    run_in "$DATADIR/gits/morphs" git commit -m 'Add default splitting rules'

    IMPLEMENTS GIVEN system (\S+) includes the default splitting rules
    cat << EOF > "$DATADIR/gits/morphs/$MATCH_1.morph"
    name: $MATCH_1
    kind: system
    arch: $(run_morph print-architecture)
    strata:
    -   name: test-stratum
        morph: test-stratum
        artifacts:
        - test-stratum-runtime
        - test-stratum-devel
    EOF
    run_in "$DATADIR/gits/morphs" git add "$MATCH_1.morph"
    run_in "$DATADIR/gits/morphs" git commit -m 'Add default splitting rules'

    IMPLEMENTS GIVEN stratum (\S+) has chunks that aren't used in (\1-\S+)
    # Create an extra chunk that will never successfully build
    cat >"$DATADIR/gits/test-chunk/unbuildable-chunk.morph" <<EOF
    name: unbuildable-chunk
    kind: chunk
    install-commands:
    - "false"
    EOF
    run_in "$DATADIR/gits/test-chunk" git add unbuildable-chunk.morph
    run_in "$DATADIR/gits/test-chunk" git commit -m 'Add unbuildable chunk'

    # Create a stratum that has an artifact that doesn't include any
    # artifacts from unbuildable-chunk
    cat >"$DATADIR/gits/morphs/$MATCH_1.morph" <<EOF
    name: $MATCH_1
    kind: stratum
    products:
    - artifact: $MATCH_2
      include:
      - test-chunk-.*
    chunks:
    - name: test-chunk
      repo: test:test-chunk
      ref: master
      morph: test-chunk
      build-mode: test
      build-depends: []
    - name: unbuildable-chunk
      repo: test:test-chunk
      ref: refs/heads/master
      morph: unbuildable-chunk
      build-mode: test
      build-depends:
      - test-chunk
    EOF
    run_in "$DATADIR/gits/morphs" git add "$MATCH_1.morph"
    run_in "$DATADIR/gits/morphs" git commit -m "add -$MATCH_2 to stratum"