add ci

2024-09-11 09:05:34 +03:00 · 2021-12-19 22:57:37 -06:00 · 2021-12-19 22:57:37 -06:00 · a75e50bc07
commit a75e50bc07
parent d9e28977bf
6 changed files with 281 additions and 39 deletions
--- a/.github/workflows/haskell-ci.yml
+++ b/.github/workflows/haskell-ci.yml
@ -0,0 +1,233 @@
+# This GitHub workflow config has been generated by a script via
+#
+#   haskell-ci 'github' 'cabal.project'
+#
+# To regenerate the script (for example after adjusting tested-with) run
+#
+#   haskell-ci regenerate
+#
+# For more information, see https://github.com/haskell-CI/haskell-ci
+#
+# version: 0.13.20211116
+#
+# REGENDATA ("0.13.20211116",["github","cabal.project"])
+#
+name: Haskell-CI
+on:
+  - push
+  - pull_request
+jobs:
+  linux:
+    name: Haskell-CI - Linux - ${{ matrix.compiler }}
+    runs-on: ubuntu-18.04
+    timeout-minutes:
+      60
+    container:
+      image: buildpack-deps:bionic
+    continue-on-error: ${{ matrix.allow-failure }}
+    strategy:
+      matrix:
+        include:
+          - compiler: ghc-9.2.1
+            compilerKind: ghc
+            compilerVersion: 9.2.1
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-9.0.1
+            compilerKind: ghc
+            compilerVersion: 9.0.1
+            setup-method: hvr-ppa
+            allow-failure: false
+          - compiler: ghc-8.10.7
+            compilerKind: ghc
+            compilerVersion: 8.10.7
+            setup-method: ghcup
+            allow-failure: false
+      fail-fast: false
+    steps:
+      - name: apt
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5
+          if [ "${{ matrix.setup-method }}" = ghcup ]; then
+            mkdir -p "$HOME/.ghcup/bin"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"
+            chmod a+x "$HOME/.ghcup/bin/ghcup"
+            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER"
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+          else
+            apt-add-repository -y 'ppa:hvr/ghc'
+            apt-get update
+            apt-get install -y "$HCNAME"
+            mkdir -p "$HOME/.ghcup/bin"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"
+            chmod a+x "$HOME/.ghcup/bin/ghcup"
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+          fi
+        env:
+          HCKIND: ${{ matrix.compilerKind }}
+          HCNAME: ${{ matrix.compiler }}
+          HCVER: ${{ matrix.compilerVersion }}
+      - name: Set PATH and environment variables
+        run: |
+          echo "$HOME/.cabal/bin" >> $GITHUB_PATH
+          echo "LANG=C.UTF-8" >> "$GITHUB_ENV"
+          echo "CABAL_DIR=$HOME/.cabal" >> "$GITHUB_ENV"
+          echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"
+          HCDIR=/opt/$HCKIND/$HCVER
+          if [ "${{ matrix.setup-method }}" = ghcup ]; then
+            HC=$HOME/.ghcup/bin/$HCKIND-$HCVER
+            echo "HC=$HC" >> "$GITHUB_ENV"
+            echo "HCPKG=$HOME/.ghcup/bin/$HCKIND-pkg-$HCVER" >> "$GITHUB_ENV"
+            echo "HADDOCK=$HOME/.ghcup/bin/haddock-$HCVER" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+          else
+            HC=$HCDIR/bin/$HCKIND
+            echo "HC=$HC" >> "$GITHUB_ENV"
+            echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"
+            echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+          fi
+
+          HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')
+          echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"
+          echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"
+          echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"
+          echo "HEADHACKAGE=false" >> "$GITHUB_ENV"
+          echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"
+          echo "GHCJSARITH=0" >> "$GITHUB_ENV"
+        env:
+          HCKIND: ${{ matrix.compilerKind }}
+          HCNAME: ${{ matrix.compiler }}
+          HCVER: ${{ matrix.compilerVersion }}
+      - name: env
+        run: |
+          env
+      - name: write cabal config
+        run: |
+          mkdir -p $CABAL_DIR
+          cat >> $CABAL_CONFIG <<EOF
+          remote-build-reporting: anonymous
+          write-ghc-environment-files: never
+          remote-repo-cache: $CABAL_DIR/packages
+          logs-dir:          $CABAL_DIR/logs
+          world-file:        $CABAL_DIR/world
+          extra-prog-path:   $CABAL_DIR/bin
+          symlink-bindir:    $CABAL_DIR/bin
+          installdir:        $CABAL_DIR/bin
+          build-summary:     $CABAL_DIR/logs/build.log
+          store-dir:         $CABAL_DIR/store
+          install-dirs user
+            prefix: $CABAL_DIR
+          repository hackage.haskell.org
+            url: http://hackage.haskell.org/
+          EOF
+          cat >> $CABAL_CONFIG <<EOF
+          program-default-options
+            ghc-options: $GHCJOBS +RTS -M3G -RTS
+          EOF
+          cat $CABAL_CONFIG
+      - name: versions
+        run: |
+          $HC --version || true
+          $HC --print-project-git-commit-id || true
+          $CABAL --version || true
+      - name: update cabal index
+        run: |
+          $CABAL v2-update -v
+      - name: install cabal-plan
+        run: |
+          mkdir -p $HOME/.cabal/bin
+          curl -sL https://github.com/haskell-hvr/cabal-plan/releases/download/v0.6.2.0/cabal-plan-0.6.2.0-x86_64-linux.xz > cabal-plan.xz
+          echo 'de73600b1836d3f55e32d80385acc055fd97f60eaa0ab68a755302685f5d81bc  cabal-plan.xz' | sha256sum -c -
+          xz -d < cabal-plan.xz > $HOME/.cabal/bin/cabal-plan
+          rm -f cabal-plan.xz
+          chmod a+x $HOME/.cabal/bin/cabal-plan
+          cabal-plan --version
+      - name: checkout
+        uses: actions/checkout@v2
+        with:
+          path: source
+      - name: initial cabal.project for sdist
+        run: |
+          touch cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/graph-trace-viz" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/exe" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/graph-trace-dot" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/graph-trace" >> cabal.project
+          cat cabal.project
+      - name: sdist
+        run: |
+          mkdir -p sdist
+          $CABAL sdist all --output-dir $GITHUB_WORKSPACE/sdist
+      - name: unpack
+        run: |
+          mkdir -p unpacked
+          find sdist -maxdepth 1 -type f -name '*.tar.gz' -exec tar -C $GITHUB_WORKSPACE/unpacked -xzvf {} \;
+      - name: generate cabal.project
+        run: |
+          PKGDIR_graph_trace_viz="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/graph-trace-viz-[0-9.]*')"
+          echo "PKGDIR_graph_trace_viz=${PKGDIR_graph_trace_viz}" >> "$GITHUB_ENV"
+          PKGDIR_exe="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/exe-[0-9.]*')"
+          echo "PKGDIR_exe=${PKGDIR_exe}" >> "$GITHUB_ENV"
+          PKGDIR_graph_trace_dot="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/graph-trace-dot-[0-9.]*')"
+          echo "PKGDIR_graph_trace_dot=${PKGDIR_graph_trace_dot}" >> "$GITHUB_ENV"
+          PKGDIR_graph_trace="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/graph-trace-[0-9.]*')"
+          echo "PKGDIR_graph_trace=${PKGDIR_graph_trace}" >> "$GITHUB_ENV"
+          rm -f cabal.project cabal.project.local
+          touch cabal.project
+          touch cabal.project.local
+          echo "packages: ${PKGDIR_graph_trace_viz}" >> cabal.project
+          echo "packages: ${PKGDIR_exe}" >> cabal.project
+          echo "packages: ${PKGDIR_graph_trace_dot}" >> cabal.project
+          echo "packages: ${PKGDIR_graph_trace}" >> cabal.project
+          echo "package graph-trace-viz" >> cabal.project
+          echo "    ghc-options: -Werror=missing-methods" >> cabal.project
+          echo "package exe" >> cabal.project
+          echo "    ghc-options: -Werror=missing-methods" >> cabal.project
+          echo "package graph-trace-dot" >> cabal.project
+          echo "    ghc-options: -Werror=missing-methods" >> cabal.project
+          echo "package graph-trace" >> cabal.project
+          echo "    ghc-options: -Werror=missing-methods" >> cabal.project
+          cat >> cabal.project <<EOF
+          EOF
+          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(exe|graph-trace|graph-trace-dot|graph-trace-viz)$/; }' >> cabal.project.local
+          cat cabal.project
+          cat cabal.project.local
+      - name: dump install plan
+        run: |
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dry-run all
+          cabal-plan
+      - name: cache
+        uses: actions/cache@v2
+        with:
+          key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
+          path: ~/.cabal/store
+          restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-
+      - name: install dependencies
+        run: |
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
+      - name: build w/o tests
+        run: |
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
+      - name: build
+        run: |
+          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
+      - name: cabal check
+        run: |
+          cd ${PKGDIR_graph_trace_viz} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_exe} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_graph_trace_dot} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_graph_trace} || false
+          ${CABAL} -vnormal check
+      - name: haddock
+        run: |
+          $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
+      - name: unconstrained build
+        run: |
+          rm -f cabal.project.local
+          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
--- a/exe/exe.cabal
+++ b/exe/exe.cabal
@ -3,16 +3,16 @@ name:               exe
 version:            0.1.0.0

 -- A short (one-line) description of the package.
-- synopsis:
+synopsis: Test executable

 -- A longer description of the package.
-- description:
+description: Test executable for @graph-viz@

 -- A URL where users can report bugs.
 -- bug-reports:

 -- The license under which the package is released.
-- license:
+license: MIT

 -- The package author(s).
 -- author:
@ -20,15 +20,16 @@ maintainer:         aaron@flipstone.com

 -- A copyright notice.
 -- copyright:
-- category:
+category: testing
 extra-source-files: CHANGELOG.md
+tested-with: GHC==9.2.1, GHC==9.0.1, GHC==8.10.7

 executable test-exe
  main-is:             Main.hs
  hs-source-dirs: app
  other-modules: Class
  -- other-extensions:
-  build-depends:       base
+  build-depends:       base >= 4.9 && < 5
                     , graph-trace
                     , random
  -- hs-source-dirs:
--- a/graph-trace-dot/graph-trace-dot.cabal
+++ b/graph-trace-dot/graph-trace-dot.cabal
@ -3,25 +3,29 @@ name:               graph-trace-dot
 version:            0.1.0.0

 -- A short (one-line) description of the package.
-- synopsis:
+synopsis:
+  Converts a graph-trace log into a DOT file for use with graphviz

 -- A longer description of the package.
-- description:
+description:
+  Creates a DOT file from a @graph-trace@ log which is useable with
+  <https://graphviz.org graphviz>.

 -- A URL where users can report bugs.
-- bug-reports:
+bug-reports: https://github.com/aaronallen8455/graph-trace/issues

 -- The license under which the package is released.
-- license:
+license: MIT

 -- The package author(s).
 -- author:
 maintainer:         aaron@flipstone.com

 -- A copyright notice.
-- copyright:
-- category:
+copyright:     Copyright (C) 2021 Aaron Allen
+category: tooling, debug, development, graph, plugin
 extra-source-files: CHANGELOG.md
+tested-with: GHC==9.2.1, GHC==9.0.1, GHC==8.10.7

 library
  default-language: Haskell2010
@ -38,7 +42,7 @@ library
 executable graph-trace-dot
  default-language: Haskell2010
  main-is: Main.hs
-  build-depends: base
+  build-depends: base >= 4.9 && < 5
               , bytestring
               , containers
               , directory
--- a/graph-trace-viz/graph-trace-viz.cabal
+++ b/graph-trace-viz/graph-trace-viz.cabal
@ -2,26 +2,29 @@ cabal-version:      2.4
 name:               graph-trace-viz
 version:            0.1.0.0

-- A short (one-line) description of the package.
-- synopsis:
+synopsis:
+  Converts a graph-trace log into an HTML document

-- A longer description of the package.
-- description:
+description:
+  Creates an HTML document with an explorable graph which represents
+  the execution of a program. Each unique invocation of a function is
+  represented as an edge in the graph.

 -- A URL where users can report bugs.
-- bug-reports:
+bug-reports: https://github.com/aaronallen8455/graph-trace/issues

 -- The license under which the package is released.
-- license:
+license: MIT

 -- The package author(s).
 -- author:
 maintainer:         aaron@flipstone.com

 -- A copyright notice.
-- copyright:
-- category:
-extra-source-files: CHANGELOG.md
+copyright:     Copyright (C) 2021 Aaron Allen
+category: tooling, debug, development, graph, plugin
+extra-source-files: CHANGELOG.md, extras/*.html
+tested-with: GHC==9.2.1, GHC==9.0.1, GHC==8.10.7

 executable graph-trace-viz
    main-is:          Main.hs
@ -31,7 +34,7 @@ executable graph-trace-viz

    -- LANGUAGE extensions used by modules in this package.
    -- other-extensions:
-    build-depends:    base,
+    build-depends:    base >= 4.9 && < 5,
                      graph-trace-dot,
                      process,
                      bytestring,
@ -39,5 +42,4 @@ executable graph-trace-viz
                      directory
    hs-source-dirs:   app
    default-language: Haskell2010
-    extra-source-files: extras/*.html
    ghc-options: -Wall
--- a/graph-trace/graph-trace.cabal
+++ b/graph-trace/graph-trace.cabal
@ -2,26 +2,28 @@ cabal-version:      2.4
 name:               graph-trace
 version:            0.1.0.0

-- A short (one-line) description of the package.
-- synopsis:
+synopsis:
+  Trace the call graph of a program

-- A longer description of the package.
-- description:
+description:
+  A plugin that instruments a program so that running it produces a log which
+  can be processed into a visual graph using @graph-trace-viz@.

 -- A URL where users can report bugs.
-- bug-reports:
+bug-reports: https://github.com/aaronallen8455/graph-trace/issues

 -- The license under which the package is released.
-- license:
+license: MIT

 -- The package author(s).
 -- author:
 maintainer:         aaron@flipstone.com

 -- A copyright notice.
-- copyright:
-- category:
+copyright:     Copyright (C) 2021 Aaron Allen
+category: tooling, debug, development, graph, plugin
 extra-source-files: CHANGELOG.md
+tested-with: GHC==9.2.1, GHC==9.0.1, GHC==8.10.7

 library
  default-language: Haskell2010
@ -33,7 +35,7 @@ library
    Graph.Trace.Internal.Solver
    Graph.Trace.Internal.Instrument
    Graph.Trace.Internal.Predicates
-  build-depends: base
+  build-depends: base >= 4.9 && < 5
               , ghc
               , ghc-prim
               , ghc-boot
--- a/graph-trace/src/Graph/Trace.hs
+++ b/graph-trace/src/Graph/Trace.hs
@ -61,14 +61,14 @@ renamedResultAction cmdLineOptions tcGblEnv
  debugTypesModule <- findImportedModule "Graph.Trace.Internal.Types"
  debugTraceModule <- findImportedModule "Graph.Trace.Internal.Trace"

-  traceMutePredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceMute")
-  traceDeepPredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceDeep")
+  traceMutePredName    <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceMute")
+  traceDeepPredName    <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceDeep")
  traceDeepKeyPredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceDeepKey")
-  tracePredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "Trace")
-  traceKeyPredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceKey")
-  traceInertPredName <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceInert")
-  entryName <- Ghc.lookupOrig debugTraceModule (Ghc.mkVarOcc "entry")
-  debugContextName <- Ghc.lookupOrig debugTypesModule (Ghc.mkTcOcc "DebugContext")
+  tracePredName        <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "Trace")
+  traceKeyPredName     <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceKey")
+  traceInertPredName   <- Ghc.lookupOrig debugTypesModule (Ghc.mkClsOcc "TraceInert")
+  entryName            <- Ghc.lookupOrig debugTraceModule (Ghc.mkVarOcc "entry")
+  debugContextName     <- Ghc.lookupOrig debugTypesModule (Ghc.mkTcOcc "DebugContext")

  let debugNames = DebugNames{..}