diff --git a/.gitignore b/.gitignore --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ .stack-work idx/ dist/ +dist-newstyle/ log/ doc/ *.swp diff --git a/.travis.yml b/.travis.yml --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ # .travis.yml file for hspec-leancheck # -# Copyright: (c) 2017-2018 Rudy Matela +# Copyright: (c) 2017-2020 Rudy Matela # License: 3-Clause BSD (see the file LICENSE) # Maintainer: Rudy Matela @@ -32,34 +32,42 @@ - travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack' - stack config set system-ghc --global true - stack --version -- cabal install --only-dependencies +- cabal install --only-dependencies || cabal install hspec hspec-core leancheck HUnit --lib script: -- make && make test && make haddock +- make && make test +- make haddock - make test-sdist - cabal test --ghc-option=-O0 -- stack $STACKR --no-terminal --skip-ghc-check test --ghc-options=-O0 +- stack --resolver $STACKVER --no-terminal --skip-ghc-check test --ghc-options=-O0 matrix: allow_failures: - ghc: 'head' include: - ghc: 'head' - env: GHCVER=head CABALVER=head + env: GHCVER=head CABALVER=head STACKVER=nightly-2020-03-28 addons: {apt: {packages: [ghc-head, cabal-install-head], sources: hvr-ghc}} + - ghc: '8.8' + env: GHCVER=8.8.3 CABALVER=3.0 STACKVER=lts-15.5 + addons: {apt: {packages: [ghc-8.8.3, cabal-install-3.0], sources: hvr-ghc}} + - ghc: '8.6' + env: GHCVER=8.6.5 CABALVER=2.4 STACKVER=lts-14.27 + addons: {apt: {packages: [ghc-8.6.5, cabal-install-2.4], sources: hvr-ghc}} - ghc: '8.4' - env: GHCVER=8.4.3 CABALVER=2.2 - addons: {apt: {packages: [ghc-8.4.3, cabal-install-2.2], sources: hvr-ghc}} + env: GHCVER=8.4.4 CABALVER=2.2 STACKVER=lts-12.26 + addons: {apt: {packages: [ghc-8.4.4, cabal-install-2.2], sources: hvr-ghc}} - ghc: '8.2' - env: GHCVER=8.2.2 CABALVER=2.0 STACK_YAML=stack-lts-11.yaml + env: GHCVER=8.2.2 CABALVER=2.0 STACKVER=lts-11.22 STACK_YAML=stack-lts-11.yaml addons: {apt: {packages: [ghc-8.2.2, cabal-install-2.0], sources: hvr-ghc}} - ghc: '8.0' - env: GHCVER=8.0.2 CABALVER=1.24 STACK_YAML=stack-lts-11.yaml + env: GHCVER=8.0.2 CABALVER=1.24 STACKVER=lts-9.21 STACK_YAML=stack-lts-9.yaml addons: {apt: {packages: [ghc-8.0.2, cabal-install-1.24], sources: hvr-ghc}} - ghc: '7.10' env: GHCVER=7.10.3 CABALVER=1.22 addons: {apt: {packages: [ghc-7.10.3, cabal-install-1.22], sources: hvr-ghc}} script: - - make && make test && make haddock + - make && make test + - make haddock - make test-sdist - cabal test --ghc-option=-O0 diff --git a/changelog.md b/changelog.md --- a/changelog.md +++ b/changelog.md @@ -2,6 +2,12 @@ ============================= +0.0.4 +----- + +* improve build scripts + + 0.0.3 ----- diff --git a/hspec-leancheck.cabal b/hspec-leancheck.cabal --- a/hspec-leancheck.cabal +++ b/hspec-leancheck.cabal @@ -1,6 +1,6 @@ -- Cabal file for hspec-leancheck name: hspec-leancheck -version: 0.0.3 +version: 0.0.4 synopsis: LeanCheck support for the Hspec test framework. description: LeanCheck support for the Hspec test framework. @@ -32,11 +32,15 @@ , mk/haddock-i , mk/All.hs , mk/Toplibs.hs + , mk/install-on , stack.yaml , stack-lts-11.yaml + , stack-lts-9.yaml , test/sdist , .travis.yml -tested-with: GHC==8.4 +tested-with: GHC==8.8 + , GHC==8.6 + , GHC==8.4 , GHC==8.2 , GHC==8.0 , GHC==7.10 @@ -49,12 +53,12 @@ source-repository this type: git location: https://github.com/rudymatela/hspec-leancheck - tag: v0.0.3 + tag: v0.0.4 library exposed-modules: Test.Hspec.LeanCheck hs-source-dirs: src - build-depends: base >= 4 && < 5, hspec >= 2.5, hspec-core, leancheck, HUnit + build-depends: base >= 4 && < 5, hspec >= 2.5, hspec-core, leancheck >= 0.9.3, HUnit default-language: Haskell2010 test-suite test diff --git a/mk/depend.mk b/mk/depend.mk --- a/mk/depend.mk +++ b/mk/depend.mk @@ -16,11 +16,6 @@ mk/Toplibs.o: \ src/Test/Hspec/LeanCheck.hs \ mk/Toplibs.hs -Setup.o: \ - Setup.hs -Setup: \ - Setup.hs \ - mk/toplibs src/Test/Hspec/LeanCheck: \ mk/toplibs src/Test/Hspec/LeanCheck.o: \ diff --git a/mk/ghcdeps b/mk/ghcdeps --- a/mk/ghcdeps +++ b/mk/ghcdeps @@ -2,7 +2,7 @@ # # ghcdeps: generate Haskell make dependencies for compiling with GHC. # -# Copyright (c) 2015-2018 Rudy Matela. +# Copyright (c) 2015-2020 Rudy Matela. # Distributed under the 3-Clause BSD licence. # # From a list of files provided on standard input, diff --git a/mk/haddock-i b/mk/haddock-i --- a/mk/haddock-i +++ b/mk/haddock-i @@ -2,7 +2,7 @@ # # haddock-i: list haddock's -i parameters. # -# Copyright (c) 2015-2018 Rudy Matela. +# Copyright (c) 2015-2020 Rudy Matela. # Distributed under the 3-Clause BSD licence. # # $ haddock-i ... @@ -11,14 +11,26 @@ # documentation installed on your system, so you can: # # $ haddock-i base template-haskell | xargs haddock -errxit() { +err() { echo "$@" > /dev/stderr +} + +errxit() { + err "$@" exit 1 } -for pkg in "$@"; do - ghc-pkg field $pkg haddock-html,haddock-interfaces || - errxit "error: haddock-i: cannot find package $pkg (ghc-pkg)" -done | -sed "s/.*: //" | -sed "N;s/\n/,/;s/^/-i/" +iface-for() { + ghc-pkg field $1 haddock-interfaces | sort -rV | head -1 | sed "s/.*: //" +} + +html-for() { + ghc-pkg field $1 haddock-html | sort -rV | head -1 | sed "s/.*: //" +} + +for pkg in "$@" +do + iface=$(iface-for $pkg) + html=$(html-for $pkg) + [ -d "$html" -a -f "$iface" ] && echo "-i$html,$iface" || err "haddock-i: warning: could not find interface file for $pkg" +done diff --git a/mk/haskell.mk b/mk/haskell.mk --- a/mk/haskell.mk +++ b/mk/haskell.mk @@ -1,6 +1,6 @@ # Implicit rules for compiling Haskell code. # -# Copyright (c) 2015-2018 Rudy Matela. +# Copyright (c) 2015-2020 Rudy Matela. # Distributed under the 3-Clause BSD licence. # # You can optionally configure the "Configuration variables" below in your main @@ -20,6 +20,7 @@ GHCFLAGS ?= GHC ?= ghc GHCCMD = $(GHC) -i$(GHCIMPORTDIRS) $(GHCFLAGS) +HADDOCK ?= haddock # Hugs Parameters HUGSIMPORTDIRS ?= "/usr/lib/hugs/packages/*" @@ -38,12 +39,24 @@ # ALL_HSS: all Haskell files # You can override ALL/LIB_HSS in your main Makefile LIST_LIB_HSS ?= find src -name "*.hs" -LIST_ALL_HSS ?= find \( -path "./dist" -o -path "./.stack-work" \) -prune \ +LIST_ALL_HSS ?= find \( -path "./dist*" -o -path "./.stack-work" -o -path "./Setup.hs" \) -prune \ -o -name "*.*hs" -print LIB_HSS ?= $(shell $(LIST_LIB_HSS)) ALL_HSS ?= $(shell $(LIST_ALL_HSS)) +LIB_DEPS ?= base +ALL_DEPS ?= $(LIB_DEPS) + PKGNAME = $(shell cat *.cabal | grep "^name:" | sed -e "s/name: *//") +HADDOCK_VERSION = $(shell $(HADDOCK) --version | grep version | sed -e 's/.*version //;s/,.*//') +HADDOCK_MAJOR = $(shell echo $(HADDOCK_VERSION) | sed -e 's/\..*//') +HADDOCK_MINOR = $(shell echo $(HADDOCK_VERSION) | sed -e 's/[0-9]*\.\([0-9]*\).[0-9]*/\1/') +HADDOCK_PKG_NAME = $(shell [ $(HADDOCK_MAJOR) -gt 2 ] \ + || [ $(HADDOCK_MAJOR) -eq 2 -a $(HADDOCK_MINOR) -ge 20 ] \ + && echo "--package-name=$(PKGNAME)") +HADDOCK_HLNK_SRC = $(shell [ $(HADDOCK_MAJOR) -gt 2 ] \ + || [ $(HADDOCK_MAJOR) -eq 2 -a $(HADDOCK_MINOR) -ge 17 ] \ + && echo "--hyperlinked-source") # Implicit rules @@ -84,7 +97,7 @@ haddock: doc/index.html clean-haddock: - rm -f doc/*.{html,css,js,png,gif,json} README.html + rm -f doc/*.{html,css,js,png,gif,json} doc/src/* README.html upload-haddock: @echo "use \`cabal upload -d' instead" @@ -93,9 +106,14 @@ @echo "(on Arch Linux, use: cabal haddock --for-hackage --haddock-options=--optghc=-dynamic)" doc/index.html: $(LIB_HSS) - ./mk/haddock-i base template-haskell | xargs \ - haddock --html -odoc $(LIB_HSS) $(HADDOCKFLAGS) --title=$(PKGNAME) + ./mk/haddock-i $(LIB_DEPS) | xargs \ + $(HADDOCK) --html -odoc $(LIB_HSS) \ + --title=$(PKGNAME) \ + $(HADDOCK_PKG_NAME) \ + $(HADDOCK_HLNK_SRC) \ + $(HADDOCKFLAGS) + # lists all Haskell source files list-all-hss: @find $(ALL_HSS) @@ -103,6 +121,12 @@ # lists library Haskell source files list-lib-hss: @find $(LIB_HSS) + +bootstrap-haskell-mk: + @[ -d "$(DEST)" ] || (echo -e "error: no destination found\nusage: \`make bootstrap-haskell-mk DEST=path/to/prj'"; exit 1) + mkdir -p mk + cp mk/{haskell.mk,ghcdeps,haddock-i} $(DEST)/mk + touch $(DEST)/mk/depend.mk show-pkgname: @echo $(PKGNAME) diff --git a/mk/install-on b/mk/install-on new file mode 100644 --- /dev/null +++ b/mk/install-on @@ -0,0 +1,30 @@ +#!/bin/bash +# +# mk/install-on: install or updates the mk folder on a Haskell project +# +# usage: ./mk/install-on path/to/project +# +# This assumes a few things: +# +# * tests are stored in a "test/" folder +# * sources are stored in a "src/" folder +set -e + +errxit() { + echo "$@" > /dev/stderr + exit 1 +} + +src=`dirname $0`/.. +dst="$1" + +[ -n "$dst" ] || errxit "destination folder not provided" + +mkdir -p $dst/mk +mkdir -p $dst/test + +cp $src/mk/ghcdeps $dst/mk/ghcdeps +cp $src/mk/haddock-i $dst/mk/haddock-i +cp $src/mk/haskell.mk $dst/mk/haskell.mk +cp $src/mk/install-on $dst/mk/install-on +cp $src/test/sdist $dst/test/sdist diff --git a/stack-lts-11.yaml b/stack-lts-11.yaml --- a/stack-lts-11.yaml +++ b/stack-lts-11.yaml @@ -1,15 +1,11 @@ -# stack.yaml for hspec-leancheck resolver: lts-11.22 packages: - . extra-deps: +- leancheck-0.9.3 - hspec-2.5.6 - hspec-core-2.5.6 - hspec-discover-2.5.6 - QuickCheck-2.12.1 - -flags: {} - -extra-package-dbs: [] diff --git a/stack-lts-9.yaml b/stack-lts-9.yaml new file mode 100644 --- /dev/null +++ b/stack-lts-9.yaml @@ -0,0 +1,12 @@ +resolver: lts-9.21 + +packages: +- . + +extra-deps: +- leancheck-0.9.3 +- hspec-2.5.6 +- hspec-core-2.5.6 +- hspec-discover-2.5.6 +- QuickCheck-2.12.1 +- HUnit-1.6.0.0 diff --git a/stack.yaml b/stack.yaml --- a/stack.yaml +++ b/stack.yaml @@ -1,15 +1,7 @@ -# stack.yaml docs: -# https://docs.haskellstack.org/en/stable/yaml_configuration/ - -# resolver: nightly-2015-09-21 -# resolver: ghc-7.10.2 -resolver: lts-12.7 +resolver: lts-15.5 # or ghc-8.8.3 packages: - . -extra-deps: [] - -flags: {} - -extra-package-dbs: [] +extra-deps: +- leancheck-0.9.3 diff --git a/test/sdist b/test/sdist --- a/test/sdist +++ b/test/sdist @@ -2,27 +2,39 @@ # # test/sdist: tests the package generated by "cabal sdist". # -# Copyright (c) 2015-2018 Rudy Matela. +# Copyright (c) 2015-2020 Rudy Matela. # Distributed under the 3-Clause BSD licence. + +set -xe + +export LC_ALL=C # consistent sort + pkgver=` cat *.cabal | grep "^version:" | sed -e "s/version: *//"` pkgname=`cat *.cabal | grep "^name:" | sed -e "s/name: *//"` -pkg=$pkgname-$pkgver -set -x -cabal sdist && -cd dist && -if [ -d ../.git ] +pkgbase=$pkgname-$pkgver + +cabal sdist + +# Try to find the package generated by cabal. +pkg=`find dist* -name $pkgbase.tar.gz` +[ -f "$pkg" ] +# If the script fails here, either: +# * no package was generated +# * there are packages in both dist and dist-newstyle folders. + +tmp=`mktemp -d /tmp/test-sdist-XXXXXXXXXX` + +# Test if our file is compatible with case-insensitive filesystems. +tar -tf $pkg | sort --ignore-case > $tmp/ls-cabal-i +tar -tf $pkg | sort --ignore-case --unique > $tmp/ls-cabal-iu +diff -rud $tmp/ls-cabal-i $tmp/ls-cabal-iu + +if [ -d .git ] then - # on git repo, test if files are the same - git -C .. ls-files | sort > ls-git && - tar -tf $pkg.tar.gz | grep -v "/$" | sed -e "s,$pkg/,," | sort > ls-cabal && - diff -rud ls-git ls-cabal && - rm -f ls-git ls-cabal -else - # outside of git repo, test build - rm -rf $pkg/ && - tar -xzf $pkg.tar.gz && - cd $pkg/ && - cabal configure --enable-tests --enable-benchmarks && - cabal build && - cabal test + # Test if files included by cabal are the same as files tracked in git. + git ls-files | sort > $tmp/ls-git + tar -tf $pkg | grep -v "/$" | sed -e "s,$pkgbase/,," | sort > $tmp/ls-cabal + diff -rud $tmp/ls-git $tmp/ls-cabal fi + +rm -r $tmp