Merge pull request #150 from haskell-works/disable-integration-tests

Disable integration tests by default

Author: AlexeyRaga

.circleci/config.yml

@@ -49,7 +49,7 @@ workflows:
           context: haskell-ci
           binary-cache-uri: ${BINARY_CACHE_URI-"http://hw-binary-cache-us-west-2-a.s3-website-us-west-2.amazonaws.com/archive"}
           cabal-build-extra: --write-ghc-environment-files=ghc8.4.4+
-          cabal-test-extra: --test-show-details=direct --test-options='+RTS -g1'
+          cabal-test-extra: --test-show-details=direct --flag it --test-options='+RTS -g1'
 
       - haskell/build-with-binary-cache:
           name: GHC 8.6.5
@@ -60,7 +60,7 @@ workflows:
           context: haskell-ci
           binary-cache-uri: ${BINARY_CACHE_URI-"http://hw-binary-cache-us-west-2-a.s3-website-us-west-2.amazonaws.com/archive"}
           cabal-build-extra: --write-ghc-environment-files=ghc8.4.4+
-          cabal-test-extra: --test-show-details=direct --test-options='+RTS -g1'
+          cabal-test-extra: --test-show-details=direct --flag it --test-options='+RTS -g1'
 
       - haskell/build-with-binary-cache:
           name: GHC 8.8.3
@@ -71,7 +71,7 @@ workflows:
           context: haskell-ci
           binary-cache-uri: ${BINARY_CACHE_URI-"http://hw-binary-cache-us-west-2-a.s3-website-us-west-2.amazonaws.com/archive"}
           cabal-build-extra: --write-ghc-environment-files=ghc8.4.4+
-          cabal-test-extra: --test-show-details=direct --test-options='+RTS -g1'
+          cabal-test-extra: --test-show-details=direct --flag it --test-options='+RTS -g1'
 
       - haskell/build-with-binary-cache:
           name: GHC 8.10.1
@@ -82,7 +82,7 @@ workflows:
           context: haskell-ci
           binary-cache-uri: ${BINARY_CACHE_URI-"http://hw-binary-cache-us-west-2-a.s3-website-us-west-2.amazonaws.com/archive"}
           cabal-build-extra: --write-ghc-environment-files=ghc8.4.4+
-          cabal-test-extra: --test-show-details=direct --test-options='+RTS -g1'
+          cabal-test-extra: --test-show-details=direct --flag it --test-options='+RTS -g1'
 
       - merge-point/merge-point:
           name: Build Ok

README.md

@@ -228,10 +228,10 @@ With [Docker Compose](./docker-compose.yml) this variable is used to configure K
 $ docker-compose up
 ```
 
-After that, tests can be run as usual:
+After that, integration tests can switched on with using 'it' flag:
 
 ```
-$ cabal test --test-show-details=direct
+$ cabal test --test-show-details=direct --flag it
 ```
 
 ## Credits

hw-kafka-client.cabal

@@ -32,6 +32,11 @@ flag examples
   manual: True
   default: False
 
+flag it
+  description: Run integration tests
+  manual: True
+  default: False
+
 library
   hs-source-dirs:       src
   ghc-options:          -Wall
@@ -103,6 +108,8 @@ test-suite integration-tests
                       , text
                       , transformers
   build-tool-depends:   hspec-discover:hspec-discover
+  if !(flag(it))
+    buildable:          False
   other-modules:        Kafka.IntegrationSpec
                         Kafka.TestEnv
   default-language:     Haskell2010

shell.nix

@@ -2,6 +2,7 @@ with import <nixpkgs> {};
 
 pkgs.mkShell {
   buildInputs = with pkgs; [
+    openssl
     zlib
     rdkafka
     nettools