Merge pull request #1 from ambarltd/sqlserver

Add sqlserver module
ambarltd · Jan 9, 2025 · 1776b9e · 1776b9e
2 parents 55334ab + 6d21a80
commit 1776b9e
Show file tree

Hide file tree

Showing 27 changed files with 654 additions and 7 deletions.
diff --git a/.github/workflows/main.yaml → .github/workflows/ambar-hs-utils.yaml b/.github/workflows/main.yaml → .github/workflows/ambar-hs-utils.yaml
@@ -1,12 +1,12 @@
-name: Build and Test
+name: ambar-hs-utils
 on:
   push:
-    paths-ignore:
-      - '**.md'
+    paths:
+      - 'ambar-hs-utils/**'
 
 # only one build per branch
 concurrency:
-  group: build-${{ github.ref }}
+  group: build-hs-utils-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
@@ -33,6 +33,7 @@ jobs:
 
       - name: Build - Configure
         run: |
+          cd ambar-hs-utils
           cabal configure --enable-tests --enable-benchmarks
           cabal build all --dry-run
         # The last step generates dist-newstyle/cache/plan.json for the cache key.
@@ -50,7 +51,9 @@ jobs:
       - name: Build - Install dependencies
         # If we had an exact cache hit, the dependencies will be up to date.
         if: steps.cache.outputs.cache-hit != 'true'
-        run: cabal build all --only-dependencies
+        run: |
+          cd ambar-hs-utils
+          cabal build all --only-dependencies
 
       # Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
       - name: Build - Save dependencies to cache
@@ -62,7 +65,11 @@ jobs:
           key: ${{ steps.cache.outputs.cache-primary-key }}
 
       - name: Build
-        run: cabal build all
+        run: |
+          cd ambar-hs-utils
+          cabal build all
 
       - name: Test
-        run: cabal test
+        run: |
+          cd ambar-hs-utils
+          cabal run ambar-hs-utils-tests
diff --git a/.github/workflows/ambar-sqlserver.yaml b/.github/workflows/ambar-sqlserver.yaml
@@ -0,0 +1,75 @@
+name: ambar-sqlserver
+on:
+  push:
+    paths:
+      - 'ambar-sqlserver/**'
+
+# only one build per branch
+concurrency:
+  group: build-sqlserver-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ghc: ['9.10.1']
+        cabal: ['3.10.3.0']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup - GHC ${{ matrix.ghc }}
+        uses: haskell-actions/setup@v2
+        id: setup
+        with:
+          ghc-version: ${{ matrix.ghc }}
+          # Defaults, added for clarity:
+          cabal-version: ${{ matrix.cabal }}
+          cabal-update: true
+
+      - name: Build - Configure
+        run: |
+          cd ambar-sqlserver
+          cabal configure --enable-tests --enable-benchmarks
+          cabal build all --dry-run
+        # The last step generates dist-newstyle/cache/plan.json for the cache key.
+
+      - name: Build - Restore cached dependencies
+        uses: actions/cache/restore@v4
+        id: cache
+        env:
+          key: ${{ runner.os }}-ghc-${{ steps.setup.outputs.ghc-version }}-cabal-${{ steps.setup.outputs.cabal-version }}
+        with:
+          path: ${{ steps.setup.outputs.cabal-store }}
+          key: ${{ env.key }}-plan-${{ hashFiles('**/plan.json') }}
+          restore-keys: ${{ env.key }}-
+
+      - name: Build - Install dependencies
+        # If we had an exact cache hit, the dependencies will be up to date.
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          cd ambar-sqlserver
+          cabal build all --only-dependencies
+
+      # Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
+      - name: Build - Save dependencies to cache
+        uses: actions/cache/save@v4
+        # If we had an exact cache hit, trying to save the cache would error because of key clash.
+        if: steps.cache.outputs.cache-hit != 'true'
+        with:
+          path: ${{ steps.setup.outputs.cabal-store }}
+          key: ${{ steps.cache.outputs.cache-primary-key }}
+
+      - name: Build
+        run: |
+          cd ambar-sqlserver
+          cabal build all
+
+      - name: Test
+        run: |
+          cd ambar-sqlserver
+          cabal run ambar-sqlserver-tests
diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
 # Ambar utility modules
 
 This includes modules that are not application-specific and that are shared across application.
+
+- `ambar-hs-utils` - General-purpose utility modules
+- `ambar-sqlserver` - Convenient Microsoft SQL Server API wrapper
diff --git a/ambar-hs-utils/README.md b/ambar-hs-utils/README.md
@@ -0,0 +1,5 @@
+# ambar-hs-utils
+
+Functions used across Ambar's code.
+
+Each module could be a package of their own, but they are kept together here for simplicity of usage.
diff --git a/ambar-hs-utils.cabal → ambar-hs-utils/ambar-hs-utils.cabal b/ambar-hs-utils.cabal → ambar-hs-utils/ambar-hs-utils.cabal
diff --git a/cabal.project → ambar-hs-utils/cabal.project b/cabal.project → ambar-hs-utils/cabal.project
diff --git a/src/Util/Async.hs → ambar-hs-utils/src/Util/Async.hs b/src/Util/Async.hs → ambar-hs-utils/src/Util/Async.hs
diff --git a/src/Util/Delay.hs → ambar-hs-utils/src/Util/Delay.hs b/src/Util/Delay.hs → ambar-hs-utils/src/Util/Delay.hs
diff --git a/src/Util/Directory.hs → ambar-hs-utils/src/Util/Directory.hs b/src/Util/Directory.hs → ambar-hs-utils/src/Util/Directory.hs
diff --git a/src/Util/Docker.hs → ambar-hs-utils/src/Util/Docker.hs b/src/Util/Docker.hs → ambar-hs-utils/src/Util/Docker.hs
diff --git a/src/Util/Exception.hs → ambar-hs-utils/src/Util/Exception.hs b/src/Util/Exception.hs → ambar-hs-utils/src/Util/Exception.hs
diff --git a/src/Util/Logger.hs → ambar-hs-utils/src/Util/Logger.hs b/src/Util/Logger.hs → ambar-hs-utils/src/Util/Logger.hs
diff --git a/src/Util/OnDemand.hs → ambar-hs-utils/src/Util/OnDemand.hs b/src/Util/OnDemand.hs → ambar-hs-utils/src/Util/OnDemand.hs
diff --git a/src/Util/Prettyprinter.hs → ambar-hs-utils/src/Util/Prettyprinter.hs b/src/Util/Prettyprinter.hs → ambar-hs-utils/src/Util/Prettyprinter.hs
diff --git a/src/Util/STM.hs → ambar-hs-utils/src/Util/STM.hs b/src/Util/STM.hs → ambar-hs-utils/src/Util/STM.hs
diff --git a/src/Util/Some.hs → ambar-hs-utils/src/Util/Some.hs b/src/Util/Some.hs → ambar-hs-utils/src/Util/Some.hs
diff --git a/src/Util/Warden.hs → ambar-hs-utils/src/Util/Warden.hs b/src/Util/Warden.hs → ambar-hs-utils/src/Util/Warden.hs
diff --git a/test/Main.hs → ambar-hs-utils/test/Main.hs b/test/Main.hs → ambar-hs-utils/test/Main.hs
diff --git a/test/Test/OnDemand.hs → ambar-hs-utils/test/Test/OnDemand.hs b/test/Test/OnDemand.hs → ambar-hs-utils/test/Test/OnDemand.hs
diff --git a/test/Test/Warden.hs → ambar-hs-utils/test/Test/Warden.hs b/test/Test/Warden.hs → ambar-hs-utils/test/Test/Warden.hs
diff --git a/utils.sh → ambar-hs-utils/utils.sh b/utils.sh → ambar-hs-utils/utils.sh
diff --git a/ambar-sqlserver/README.md b/ambar-sqlserver/README.md
@@ -0,0 +1,9 @@
+# ambar-sqlserver
+
+A wrapper around the [`mssql-simple`](https://hackage.haskell.org/package/mssql-simple) library to provide:
+- Applicative interfaces for field and row parsing.
+- Ability to provide explicit parsers for queries.
+- A strongly typed `Query` type with automatic transaction wrapping.
+- A `ToRow` class for standardised encoding of types in queries.
+
+-
diff --git a/ambar-sqlserver/ambar-sqlserver.cabal b/ambar-sqlserver/ambar-sqlserver.cabal
@@ -0,0 +1,50 @@
+cabal-version:      3.4
+name:               ambar-sqlserver
+version:            0.1.0.0
+license:            NONE
+author:             Ambar
+maintainer:         [email protected]
+category:           Database
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+
+common common
+    ghc-options: -Wall
+    default-extensions:
+        DerivingStrategies
+        LambdaCase
+        OverloadedStrings
+        RecordWildCards
+        TypeFamilies
+        TypeFamilyDependencies
+        DeriveAnyClass
+
+library
+    import:           common
+    exposed-modules:
+        Database.SQLServer
+    build-depends:
+        base ^>=4.20.0.0
+        , ambar-hs-utils
+        , bytestring
+        , base16
+        , text
+        , ms-tds
+        , mssql-simple
+
+    hs-source-dirs:   src
+    default-language: GHC2021
+
+test-suite ambar-sqlserver-tests
+    import:           common
+    default-language: GHC2021
+    type:             exitcode-stdio-1.0
+    hs-source-dirs:   test
+    main-is:          Main.hs
+    build-depends:
+        base ^>=4.20.0.0
+        , ambar-hs-utils
+        , ambar-sqlserver
+        , bytestring
+        , text
+        , hspec
diff --git a/ambar-sqlserver/cabal.project b/ambar-sqlserver/cabal.project
@@ -0,0 +1,4 @@
+with-compiler: ghc-9.10.1
+packages:
+ .
+ ../ambar-hs-utils