Revert "Coverage"

We did not consider that to publish our snap via launchpad, we require static `snapcraft.yaml` file present in the repository. Reverts #184 Signed-off-by: Martin Kalcok <[email protected]>
canonical · Sep 30, 2024 · b90ab20 · b90ab20
1 parent 6c1c3cf
commit b90ab20
Show file tree

Hide file tree

Showing 23 changed files with 19 additions and 269 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -17,8 +17,6 @@ jobs:
 
       - name: Lint
         run: |
-          autoconf
-          ./configure --disable-dep-check
           make check-lint
 
   build:
@@ -61,10 +59,7 @@ jobs:
               --classic
 
       - name: Build snap
-        run: |
-          autoconf
-          ./configure --enable-coverage
-          make $MICROOVN_SNAP
+        run: make $MICROOVN_SNAP
 
       - name: Upload artifacts
         if: always()
@@ -136,66 +131,5 @@ jobs:
           sudo lxd init --auto
           snap list
 
-      - name: Configure repository
-        run: |
-          autoconf
-          ./configure --enable-coverage --disable-dep-check
-
       - name: Run system tests
-        run: SKIP_SNAP_REBUILD=yes make tests/${{ matrix.test-file }}
-
-      - name: Upload test coverage
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ matrix.test-file }}_coverage
-          path: ${{ github.workspace }}/.coverage
-          include-hidden-files: true
-          retention-days: 1
-
-  generate-coverage:
-    name: Generate coverage profile
-    needs:
-      - metadata
-      - system-tests
-    # 'ubuntu-latest' currently resolves to '22.04' [0] and since we require "Go >=1.20"
-    # for coverage tools, we need to use explicit 'ubuntu-24.04' image name.
-    # [0] https://github.com/actions/runner-images/issues/10636
-    runs-on: ubuntu-24.04
-    env:
-      COVERAGE_DIR: ${{ github.workspace }}/.coverage
-      COVERAGE_MERGED: ${{ github.workspace }}/.coverage/_merged
-      COVERAGE_MERGED_PROFILE: ${{ github.workspace }}/.coverage/_merged/profile.out
-    steps:
-      - name: Install dependencies
-        run: |
-          sudo apt install -yqq golang
-          go install github.com/boumenot/[email protected]
-
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Download test coverage data
-        uses: actions/download-artifact@v4
-        with:
-          path: ${{ env.COVERAGE_DIR }}
-          pattern: "*_coverage"
-
-      - name: Merge test coverage data
-        run: |
-          mkdir -p "$COVERAGE_MERGED"
-          coverage_inputs=$(find "$COVERAGE_DIR" -type d -name coverage | tr '\n' ',' | sed 's/,$//g')
-          go tool covdata merge -i="$coverage_inputs" -o="$COVERAGE_MERGED"
-          go tool covdata textfmt -i="$COVERAGE_MERGED" -o="$COVERAGE_MERGED_PROFILE"
-
-      - name: Generate cobertura.xml
-        run: |
-          cd microovn/
-          $HOME/go/bin/gocover-cobertura < "$COVERAGE_MERGED_PROFILE" > "$COVERAGE_DIR/cobertura.xml"
-
-      - name: Upload cobertura.xml
-        uses: actions/upload-artifact@v4
-        with:
-          name: cobertura.xml
-          path: ${{ env.COVERAGE_DIR }}/cobertura.xml
-          include-hidden-files: true
-
+        run: .bats/bats-core/bin/bats tests/${{ matrix.test-file }}
diff --git a/.gitignore b/.gitignore
@@ -1,30 +1 @@
 *.snap
-
-# Files that are generated by configure script
-Makefile
-snap/snapcraft.yaml
-snapcraft/commands/daemon.start
-snapcraft/commands/microovn
-
-# autoconf files
-autom4te.cache
-/autoscan.log
-/autoscan-*.log
-/aclocal.m4
-/compile
-/config.cache
-/config.guess
-/config.h.in
-/config.log
-/config.status
-/config.sub
-/configure
-/configure~
-/configure.scan
-/depcomp
-/install-sh
-/missing
-/stamp-h1
-
-# Test coverage files
-.coverage/
diff --git a/Makefile.in → Makefile b/Makefile.in → Makefile
@@ -8,9 +8,6 @@ MICROOVN_SOURCES := $(shell find microovn/ -type f)
 COMMAND_WRAPPERS := $(shell find snapcraft/ -type f)
 SNAP_SOURCES := $(shell find snap/ -type f)
 
-export MICROOVN_COVERAGE_DST := $(CURDIR)/.coverage
-export MICROOVN_COVERAGE_ENABLED := @GO_COVERAGE_ENABLED@
-
 check: check-lint check-system
 
 check-tabs:
@@ -30,18 +27,11 @@ $(ALL_TESTS): $(MICROOVN_SNAP)
 check-system: $(ALL_TESTS)
 
 $(MICROOVN_SNAP): $(MICROOVN_SOURCES) $(SNAP_SOURCES) $(COMMAND_WRAPPERS)
-	@if [ "$(SKIP_SNAP_REBUILD)" = "yes" ]; then	\
-		echo "Skipping snap build";					\
-	else											\
-		echo "Building the snap";					\
-		snapcraft pack -v -o $(MICROOVN_SNAP);		\
-	fi
+	echo "Building the snap";						\
+	snapcraft pack -v -o $(MICROOVN_SNAP)
 
 clean:
 	rm -f $(MICROOVN_SNAP_PATH);						\
 	snapcraft clean
 
-distclean: clean
-	git clean -fdX
-
-.PHONY: $(ALL_TESTS) clean check-system check-lint check-tabs distclean
+.PHONY: $(ALL_TESTS) clean check-system check-lint check-tabs
diff --git a/configure.ac b/configure.ac
diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt
@@ -23,7 +23,6 @@ VMs
 Virtualization
 YY
 appctl
-autoconf
 backport
 bugfixes
 codebase
@@ -38,7 +37,6 @@ installable
 lifecycle
 linter
 linters
-lxd
 manpage
 northd
 ovs
@@ -48,7 +46,6 @@ reST
 reStructuredText
 readthedocs
 schemas
-snapcraft
 submodules
 systemd
 unencrypted

diff --git a/docs/developers/building.rst b/docs/developers/building.rst
@@ -9,36 +9,23 @@ want to test your changes locally.
 Build requirements
 ------------------
 
-MicroOVN is distributed as a snap and most of the build requirements are handled
-by ``snapcraft`` automatically. However your build host will need:
+MicroOVN is distributed as a snap and the only requirements for building it
+are ``Make`` and ``snapcraft``. You can install them with:
 
-* make
-* autoconf
-* snapcraft
-* lxd
+.. code-block:: none
 
-Bootstrap the build environment
--------------------------------
+   sudo apt install make
+   sudo snap install snapcraft --classic
 
 Snapcraft requires ``LXD`` to build snaps. So if your system does not have LXD
 installed and initiated, you can check out either `LXD getting started
 guides`_ or go with following default setup:
 
 .. code-block:: none
 
+   sudo snap install lxd
    lxd init --auto
 
-Before you can build MicroOVN, you will need to configure the build with:
-
-.. code-block:: none
-
-   autoconf
-   ./configure
-
-You can check available ``Optional Features`` in the output of
-``./configure --help``, and reconfigure the build environment any time by
-running ``./configure`` with the desired feature flags.
-
 Build MicroOVN
 --------------
 

diff --git a/docs/developers/testing.rst b/docs/developers/testing.rst
@@ -128,18 +128,6 @@ is supported through the use of the ``LXC_REMOTE`` `LXD environment`_ variable.
    To avoid interleaving output from these parallel test suites, you can
    specify the ``-O`` argument as well.
 
-Test coverage information
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-When MicroOVN build is configured with the code coverage support via
-``./configure --enable-coverage`` (see more information about bootstrapping
-and configuring build environment in :doc:`Build MicroOVN <building>` page),
-all functional tests will automatically collect coverage information, when
-executed via ``make``. You can find collected data in the ``.coverage/``
-directory, where it's organised in a ``<test_name>/<container_name>/coverage``
-structure. For more information about the coverage data format and what you can
-do with it, see `Go Coverage Documentation`_.
-
 Clean up
 ~~~~~~~~
 
@@ -167,4 +155,3 @@ Any leftover containers will be named according to:
 .. _LXD remotes: https://documentation.ubuntu.com/lxd/en/latest/remotes/
 .. _LXD environment: https://documentation.ubuntu.com/lxd/en/latest/environment/
 .. _golangci-lint: https://golangci-lint.run/
-.. _Go Coverage Documentation: https://go.dev/doc/build-cover#working
diff --git a/snap/snapcraft.yaml.in → snap/snapcraft.yaml b/snap/snapcraft.yaml.in → snap/snapcraft.yaml
@@ -279,25 +279,28 @@ parts:
       ovs_pkg_version=$(
           dpkg-deb -f \
           $CRAFT_PART_SRC/../../ovs/stage_packages/openvswitch-switch*.deb Version)
-
+      git_version=$(
+          git -C $CRAFT_PROJECT_DIR describe \
+              --always \
+              --dirty \
+              --abbrev=10)
+      
       # Set Snap's version string
       # Note (mkalcok): Short version string does not include potential package snapshot hash.
       #                 This is required because Snap's version string is limited to 32 chars
       #                 and inclusion of snapshot hash violates this boundary.
       ovn_pkg_short_version=$(echo $ovn_pkg_version | sed -rne 's/([0-9.]+)[-+~].*$$/\1/p')
-      craftctl set version=${ovn_pkg_short_version}+snap@PACKAGE_VERSION@
+      craftctl set version=${ovn_pkg_short_version}+snap${git_version}
       
       version_package=github.com/canonical/microovn/microovn/version
-      go_ldflags="-X '${version_package}.MicroOvnVersion=@PACKAGE_VERSION@' \
+      go_ldflags="-X '${version_package}.MicroOvnVersion=${git_version}' \
                   -X '${version_package}.OvnVersion=${ovn_pkg_version}' \
                   -X '${version_package}.OvsVersion=${ovs_pkg_version}'"
       # Build the binaries
       go build -o "${CRAFT_PART_INSTALL}/bin/microovn" \
-               @GO_COVERAGE_ARG@ \
                -ldflags "$go_ldflags" \
                ./cmd/microovn
       go build -o "${CRAFT_PART_INSTALL}/bin/microovnd" \
-               @GO_COVERAGE_ARG@ \
                -ldflags "$go_ldflags" \
                -tags=libsqlite3 \
                ./cmd/microovnd
@@ -340,7 +343,6 @@ parts:
       usr/lib/: lib/
     prime:
       - commands/*
-      - -commands/*.in
       - ./*.env
       - bin/jq
       - lib/*/libjq.so*

diff --git a/snapcraft/commands/daemon.start.in → snapcraft/commands/daemon.start b/snapcraft/commands/daemon.start.in → snapcraft/commands/daemon.start
@@ -1,6 +1,4 @@
 #!/bin/sh
-@GO_COVERAGE_OUTPUT@
-
 export DQLITE_SOCKET="@snap.${SNAP_INSTANCE_NAME}.dqlite"
 export OVS_RUNDIR="${SNAP_COMMON}/run/switch/"
 

diff --git a/snapcraft/commands/microovn.in → snapcraft/commands/microovn b/snapcraft/commands/microovn.in → snapcraft/commands/microovn
@@ -1,4 +1,2 @@
 #!/bin/sh
-@GO_COVERAGE_OUTPUT@
-
 exec microovn --state-dir "${SNAP_COMMON}/state" "$@"
diff --git a/snapcraft/coverage_include b/snapcraft/coverage_include
diff --git a/tests/scaleup_cluster.bats b/tests/scaleup_cluster.bats
@@ -14,7 +14,6 @@ setup() {
 }
 
 teardown() {
-    collect_coverage $TEST_CONTAINERS
     delete_containers $TEST_CONTAINERS
 }
 

diff --git a/tests/test_helper/bats/lifecycle.bats b/tests/test_helper/bats/lifecycle.bats
@@ -13,7 +13,6 @@ setup_file() {
 }
 
 teardown_file() {
-    collect_coverage $TEST_CONTAINERS
     delete_containers $TEST_CONTAINERS
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,6 @@ setup() { @@
     }
     teardown() {
-        collect_coverage $TEST_CONTAINERS
         delete_containers $TEST_CONTAINERS
     }
@@ Expand Down @@