haskell/minio-hs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add dev flag to cabal file and update README (#182)

Browse Source 
This turns on the GHC option `-Werror` to ensure that warnings fail the
build in dev mode. The flag is enabled in the CI.

README is updated with cabal based instructions.
This commit is contained in:
Aditya Manthramurthy 2022-10-04 15:07:41 -07:00 committed by GitHub
parent 0b3a5559fd
commit d87d67b75b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 82 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/workflows/ci.yml vendored
View File

@ -80,7 +80,7 @@ jobs:
- name: Configure - name: Configure
run: | run: |
cabal configure --enable-tests --enable-benchmarks --test-show-details=direct -fexamples -flive-test cabal configure --enable-tests --enable-benchmarks --test-show-details=direct -fexamples -fdev -flive-test
- name: Freeze - name: Freeze
run: | run: |
@ -98,11 +98,11 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: | run: |
cabal build all --only-dependencies -fexamples -flive-test cabal build --only-dependencies
- name: Build - name: Build
run: | run: |
cabal build all -fexamples cabal build
- name: Setup MinIO for testing (Linux) - name: Setup MinIO for testing (Linux)
if: matrix.os == 'ubuntu-latest' if: matrix.os == 'ubuntu-latest'
@ -135,7 +135,7 @@ jobs:
/tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log & /tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log &
ghc --version ghc --version
cabal --version cabal --version
cabal test all -flive-test cabal test
- name: Test (Windows) - name: Test (Windows)
if: matrix.os == 'windows-latest' if: matrix.os == 'windows-latest'
@ -143,7 +143,7 @@ jobs:
Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4" Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4"
ghc --version ghc --version
cabal --version cabal --version
cabal test all -flive-test cabal test
stack: stack:
name: stack / ghc ${{ matrix.ghc }} name: stack / ghc ${{ matrix.ghc }}
@ -188,7 +188,7 @@ jobs:
- name: Build - name: Build
run: | run: |
stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --flag minio-hs:examples stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --flag minio-hs:examples --flag minio-hs:live-test --flag minio-hs:dev
- name: Setup MinIO for testing (Linux) - name: Setup MinIO for testing (Linux)
if: matrix.os == 'ubuntu-latest' if: matrix.os == 'ubuntu-latest'
@ -221,7 +221,7 @@ jobs:
/tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log & /tmp/minio/minio server --quiet --certs-dir /tmp/minio-config/certs data1 data2 data3 data4 2>&1 > minio.log &
ghc --version ghc --version
stack --version stack --version
stack test --system-ghc --flag minio-hs:live-test stack test --system-ghc --flag minio-hs:live-test --flag minio-hs:dev
- name: Test (Windows) - name: Test (Windows)
if: matrix.os == 'windows-latest' if: matrix.os == 'windows-latest'
@ -229,4 +229,4 @@ jobs:
Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4" Start-Process -NoNewWindow -FilePath "$HOME/minio.exe" -ArgumentList "--certs-dir", "$env:temp/minio-config/certs", "server", "$env:temp/data1", "$env:temp/data2", "$env:temp/data3", "$env:temp/data4"
ghc --version ghc --version
cabal --version cabal --version
stack test --system-ghc --flag minio-hs:live-test stack test --system-ghc --flag minio-hs:live-test --flag minio-hs:dev

87
README.md
View File

@ -1,10 +1,8 @@
# MinIO Client SDK for Haskell [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) # MinIO Haskell Client SDK for Amazon S3 Compatible Cloud Storage [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)
The MinIO Haskell Client SDK provides simple APIs to access [MinIO](https://min.io) and Amazon S3 compatible object storage server. The MinIO Haskell Client SDK provides simple APIs to access [MinIO](https://min.io) and any Amazon S3 compatible object storage.
## Minimum Requirements This guide assumes that you have a working [Haskell development environment](https://www.haskell.org/downloads/).
- The Haskell [stack](https://docs.haskellstack.org/en/stable/README/)
## Installation ## Installation
@ -12,20 +10,35 @@ The MinIO Haskell Client SDK provides simple APIs to access [MinIO](https://min.
Simply add `minio-hs` to your project's `.cabal` dependencies section or if you are using hpack, to your `package.yaml` file as usual. Simply add `minio-hs` to your project's `.cabal` dependencies section or if you are using hpack, to your `package.yaml` file as usual.
### Try it out directly with `ghci` ### Try it out in a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop)
#### For a cabal based environment
Download the library source and change to the extracted directory:
``` sh
$ cabal get minio-hs
$ cd minio-hs-1.6.0/ # directory name could be different
```
Then load the `ghci` REPL environment with the library and browse the available APIs:
``` sh
$ cabal repl
ghci> :browse Network.Minio
```
#### For a stack based environment
From your home folder or any non-haskell project directory, just run: From your home folder or any non-haskell project directory, just run:
```sh ```sh
stack install minio-hs stack install minio-hs
``` ```
Then start an interpreter session and browse the available APIs with: Then start an interpreter session and browse the available APIs with:
```sh ```sh
$ stack ghci $ stack ghci
> :browse Network.Minio > :browse Network.Minio
``` ```
@ -134,44 +147,52 @@ main = do
### Development ### Development
To setup: #### Download the source
```sh ```sh
git clone https://github.com/minio/minio-hs.git $ git clone https://github.com/minio/minio-hs.git
$ cd minio-hs/
```
cd minio-hs/ #### Build the package:
stack install With `cabal`:
```
Tests can be run with:
```sh ```sh
$ # Configure cabal for development enabling all optional flags defined by the package.
stack test $ cabal configure --enable-tests --test-show-details=direct -fexamples -fdev -flive-test
$ cabal build
``` ```
A section of the tests use the remote MinIO Play server at `https://play.min.io` by default. For library development, using this remote server maybe slow. To run the tests against a locally running MinIO live server at `http://localhost:9000`, just set the environment `MINIO_LOCAL` to any value (and unset it to switch back to Play). With `stack`:
To run the live server tests, set a build flag as shown below: ``` sh
$ stack build --test --no-run-tests --flag minio-hs:live-test --flag minio-hs:dev --flag minio-hs:examples
```
#### Running tests:
A section of the tests use the remote MinIO Play server at `https://play.min.io` by default. For library development, using this remote server maybe slow. To run the tests against a locally running MinIO live server at `http://localhost:9000` with the credentials `access_key=minio` and `secret_key=minio123`, just set the environment `MINIO_LOCAL` to any value (and unset it to switch back to Play).
With `cabal`:
```sh ```sh
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
stack test --flag minio-hs:live-test $ cabal test
# OR against a local MinIO server with:
MINIO_LOCAL=1 stack test --flag minio-hs:live-test
``` ```
The configured CI system always runs both test-suites for every change. With `stack`:
Documentation can be locally built with: ``` sh
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
stack test --flag minio-hs:live-test --flag minio-hs:dev
```
This will run all the test suites.
#### Building documentation:
```sh ```sh
$ cabal haddock
stack haddock $ # OR
$ stack haddock
``` ```

29
minio-hs.cabal
View File

@ -14,21 +14,28 @@ maintainer: dev@min.io
category: Network, AWS, Object Storage category: Network, AWS, Object Storage
build-type: Simple build-type: Simple
stability: Experimental stability: Experimental
extra-source-files: extra-doc-files:
CHANGELOG.md CHANGELOG.md
CONTRIBUTING.md CONTRIBUTING.md
docs/API.md docs/API.md
examples/*.hs
README.md README.md
extra-source-files:
examples/*.hs
stack.yaml stack.yaml
tested-with: GHC == 8.8.4 tested-with: GHC == 8.6.5
, GHC == 8.8.4
, GHC == 8.10.7 , GHC == 8.10.7
, GHC == 9.0.2 , GHC == 9.0.2
, GHC == 9.2.4
source-repository head source-repository head
type: git type: git
location: https://github.com/minio/minio-hs.git location: https://github.com/minio/minio-hs.git
Flag dev
Description: Build package in development mode
Default: False
Manual: True
common base-settings common base-settings
ghc-options: -Wall ghc-options: -Wall
@ -41,16 +48,20 @@ common base-settings
ghc-options: -Wredundant-constraints ghc-options: -Wredundant-constraints
if impl(ghc >= 8.2) if impl(ghc >= 8.2)
ghc-options: -fhide-source-paths ghc-options: -fhide-source-paths
-- Add this when we have time. Fixing partial-fields requires major version
-- bump at this time.
if impl(ghc >= 8.4) if impl(ghc >= 8.4)
ghc-options: -Wpartial-fields ghc-options: -Wpartial-fields
-- -Wmissing-export-lists -- -Wmissing-export-lists
if impl(ghc >= 8.8) if impl(ghc >= 8.8)
ghc-options: -Wmissing-deriving-strategies ghc-options: -Wmissing-deriving-strategies
-Werror=missing-deriving-strategies -Werror=missing-deriving-strategies
-- if impl(ghc >= 8.10)
-- ghc-options: -Wunused-packages -- disabled due to bug related to mixin config
if impl(ghc >= 9.0)
ghc-options: -Winvalid-haddock
if impl(ghc >= 9.2)
ghc-options: -Wredundant-bang-patterns
if flag(dev)
ghc-options: -Werror
default-language: Haskell2010 default-language: Haskell2010
@ -105,7 +116,6 @@ common base-settings
, cryptonite-conduit >= 0.2 , cryptonite-conduit >= 0.2
, digest >= 0.0.1 , digest >= 0.0.1
, directory , directory
, exceptions
, filepath >= 1.4 , filepath >= 1.4
, http-client >= 0.5 , http-client >= 0.5
, http-client-tls , http-client-tls
@ -114,7 +124,6 @@ common base-settings
, ini , ini
, memory >= 0.14 , memory >= 0.14
, network-uri , network-uri
, raw-strings-qq >= 1
, resourcet >= 1.2 , resourcet >= 1.2
, retry , retry
, text >= 1.2 , text >= 1.2
@ -153,6 +162,7 @@ test-suite minio-hs-live-server-test
, Network.Minio.XmlGenerator.Test , Network.Minio.XmlGenerator.Test
, Network.Minio.XmlParser.Test , Network.Minio.XmlParser.Test
build-depends: minio-hs build-depends: minio-hs
, raw-strings-qq
, tasty , tasty
, tasty-hunit , tasty-hunit
, tasty-quickcheck , tasty-quickcheck
@ -167,6 +177,7 @@ test-suite minio-hs-test
hs-source-dirs: test, src hs-source-dirs: test, src
main-is: Spec.hs main-is: Spec.hs
build-depends: minio-hs build-depends: minio-hs
, raw-strings-qq
, QuickCheck , QuickCheck
, tasty , tasty
, tasty-hunit , tasty-hunit