spread.yaml

project: charmcraft

path: /charmcraft
environment:
  PROJECT_PATH: /charmcraft
  SNAPD_TESTING_TOOLS: $PROJECT_PATH/tools/external/tools
  PATH: /snap/bin:$PATH:$SNAPD_TESTING_TOOLS

backends:
  google:
    key: '$(HOST: echo "$SPREAD_GOOGLE_KEY")'
    location: snapd-spread/us-east1-b
    halt-timeout: 2h
    systems:
      - ubuntu-18.04-64:
          workers: 2
          storage: 40G
      - ubuntu-20.04-64:
          workers: 4
          storage: 40G
      - ubuntu-22.04-64:
          workers: 4
          storage: 40G
      # Fedora is disabled until it runs kernel 6.0.7 due to squashfs bug
      # (https://forum.snapcraft.io/t/unsupported-version-0-of-verneed-record-linux-6-0/32160/14)
      #- fedora-35-64:
      #    workers: 2
      #    storage: 40G

  multipass:
    type: adhoc
    allocate: |
      if [ "$SPREAD_SYSTEM" = "ubuntu-18.04-64" ]; then
        image="18.04"
        instance_name="spread-18-04"
      elif [ "$SPREAD_SYSTEM" = "ubuntu-20.04-64" ]; then
        image="20.04"
        instance_name="spread-20-04"
      elif [ "$SPREAD_SYSTEM" = "ubuntu-22.04-64" ]; then
        image="22.04"
        instance_name="spread-22-04"
      else
        FATAL "$SPREAD_SYSTEM is not supported!"
      fi

      multipass launch --disk 20G --mem 2G --name "$instance_name" "$image"

      # Get the IP from the instance
      ip=$(multipass info --format csv "$instance_name" | tail -1 | cut -d\, -f3)
      # Enable PasswordAuthertication for root over SSH.
      multipass exec "$instance_name" -- \
        sudo sh -c "echo root:ubuntu | sudo chpasswd"
      multipass exec "$instance_name" -- \
        sudo sh -c \
        "sed -i /etc/ssh/sshd_config -e 's/^PasswordAuthentication.*/PasswordAuthentication yes/' -e 's/^#PermitRootLogin.*/PermitRootLogin yes/'"
      multipass exec "$instance_name" -- \
        sudo systemctl restart ssh

      ADDRESS "$ip:22"

    discard: |
      if [ "$SPREAD_SYSTEM" = "ubuntu-18.04-64" ]; then
        instance_name="spread-18-04"
      elif [ "$SPREAD_SYSTEM" = "ubuntu-20.04-64" ]; then
        instance_name="spread-20-04"
      elif [ "$SPREAD_SYSTEM" = "ubuntu-22.04-64" ]; then
        instance_name="spread-22-04"
      else
        FATAL "$SPREAD_SYSTEM is not supported!"
      fi

      multipass delete --purge "$instance_name"

    systems:
      - ubuntu-18.04-64:
          workers: 1
          username: root
          password: ubuntu
      - ubuntu-20.04-64:
          workers: 1
          username: root
          password: ubuntu
      - ubuntu-22.04-64:
          workers: 1
          username: root
          password: ubuntu

prepare: |
  set -e

  # if the 'tools' directory inside the submodule does not exist, then assume the submodule is empty
  if [[ ! -d "$SNAPD_TESTING_TOOLS" ]]; then
    echo "Cannot run spread because submodule 'snapd-testing-tools' is empty. Fetch with 'git submodule update --init' and rerun spread."
    exit 1
  fi

  if os.query is-ubuntu; then
    tempfile="$(mktemp)"
    if ! apt-get update > "$tempfile" 2>&1; then
        cat "$tempfile"
        exit 1
    fi
  fi

  tests.pkgs install snapd

  snap wait system seed.loaded

  # The /snap directory does not exist in some environments
  [ ! -d /snap ] && ln -s /var/lib/snapd/snap /snap

  # install lxd (previously removing the APT version, if there)
  [ -e /usr/bin/lxd ] && apt-get remove --purge --yes lxd lxd-client lxcfs liblxc1
  snap install lxd

  # Hold snap refreshes for 24h.
  snap set system refresh.hold="$(date --date=tomorrow +%Y-%m-%dT%H:%M:%S%:z)"
  if ! snap watch --last=auto-refresh?; then
      journalctl -xe
  fi
  if ! snap watch --last=install?; then
      journalctl -xe
  fi

  lxd waitready --timeout=30
  lxd init --auto

  #shellcheck source=tests/spread/tools/prepare.sh
  . "/charmcraft/tests/spread/tools/prepare.sh"

  install_charmcraft

suites:
  tests/spread/commands/:
    summary: simple charmcraft commands
  tests/spread/charms/:
    summary: real charm building tests
  tests/spread/smoketests/:
    summary: basic charm builds in different combinations
    systems:
      - ubuntu-20.04-64
      - ubuntu-22.04-64
  tests/spread/hooks/:
    summary: snap hook tests
    kill-timeout: 30m
  tests/spread/store/:
    prepare: |
      snap install docker
      # make sure docker is working
      retry -n 10 --wait 2 sh -c 'docker run --rm hello-world'
      # https://linuxcontainers.org/lxd/docs/master/howto/network_bridge_firewalld/#prevent-issues-with-lxd-and-docker
      # https://github.com/canonical/lxd-cloud/blob/f20a64a8af42485440dcbfd370faf14137d2f349/test/includes/lxd.sh#L13-L23
      iptables -P FORWARD ACCEPT
    restore: |
      snap remove docker --purge
    summary: sequence of commands for different store-related functionalities
    kill-timeout: 30m
    manual: true
    systems:
      - ubuntu-22.04-64
    environment:
      # the content for this key is the content of FILE after running
      #     charmcraft login --export=FILE --ttl=5184000#
      # (as the owner of CHARM_DEFAULT_NAME and BUNDLE_DEFAULT_NAME below), and it
      # should be part of the environment (when running spread locally just define it,
      # for GH actions set it in Settings -> Security -> Actions -> Repository secrets)
      CHARMCRAFT_AUTH: "$(HOST: echo $CHARMCRAFT_AUTH)"

      # to not flood Charmhub with names the same two are always used in the Store related
      # tests (except in the names registration tests, of course); register them manually
      # in staging Charmhub authenticating with the configured credentials
      CHARM_DEFAULT_NAME: "$(HOST: echo ${CHARM_DEFAULT_NAME:-$USER-test-charm})"
      BUNDLE_DEFAULT_NAME: "$(HOST: echo ${BUNDLE_DEFAULT_NAME:-$USER-test-bundle})"