hasql-explain-tests (empty) → 0.1.0.0
raw patch · 6 files changed
+715/−0 lines, 6 filesdep +QuickCheckdep +basedep +bytestring
Dependencies added: QuickCheck, base, bytestring, hasql, hasql-explain-tests, hspec, profunctors, tasty, tasty-hunit, tmp-postgres
Files
- CHANGELOG.md +5/−0
- LICENSE +373/−0
- Readme.markdown +99/−0
- hasql-explain-tests.cabal +57/−0
- src/Test/Database/Hasql.hs +152/−0
- test/simple.hs +29/−0
+ CHANGELOG.md view
@@ -0,0 +1,5 @@+# Revision history for hasql-explain-tests++## 0.1.0.0 -- 2020-03-08++* First version. Introduce basic explain tests.
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ Readme.markdown view
@@ -0,0 +1,99 @@+This library proves a test interface for [hasql](https://hackage.haskell.org/package/hasql) library.+Hasql is very performant Postgres client library for Haskell, that allows to write raw SQL queries.+Ability to write raw queries allows to use the full set of the database engine features and easy+debug and analysis using external tools. ++However when writing raw queries it's very easy to make a mistake and this mistake+will not be checked by the compiler. This library tries to solve the problem by introducing+helpers to test queries.++# Features++The library provides some basic tests of the database queries:++ * `explain tests` - tests that checks that we can call explain on the query+ this test will guarantee that the database can parse the query and run+ it in the current schema. This test also automatically checks parameters+ encoding.++# How to use the library.++At this moment there is no automation that would allow to gather all the queries across the+project. So usually the simplest way is to export all the queries from the module:++```haskell+module A + ( ...+ , queries+ ) where+++queries :: (String, SomeQuery)+queries =+ [ "queryName" =>> queryName + , "anotherQuery" =>> anotherQuery+ ]+```++And use that function in the test suite:++```haskell+module Main (main) where++import Test.Tasty+import Test.Tasty.HUnit+import A qualified++main = defaultMain $+ withResource (startupPostgres) (teardownPostgres) $ mkDb ->+ withResource (mkDb >>= allocateConnection) (freeConnection) $ conn ->+ tests conn++tests :: IO HC.Connection -> TestGroup+tests mkConn = testGroup "explain-tests" $+ [ testGroup "A" $ A.queries <&> \(name, SomeQuery q) ->+ testCase name $ mkConn >>= explain q+ ]+```++## Using the library with Nix++There are a plenty of the approaches that can allow to use the library with+nix, but we prefer the following:+ + 1. Add the package to the `haskellPackages` set by any means+ 2. Write a wrapper that will add a dependency on the Postgres server of+ the required version:++ ```nix+ { hpkgs # haskell packages set+ , haskell # haskell lib+ , postgresql_11 # postgres version+ }:+ + haskell.lib.overrideCabal hpkgs.db-tests (drv: {+ # Add postgres server to the tests dependencies:+ testDepends = (drv.testDepends or []) ++ [postgresql_11];+ # have streaming logs, very useful for CI+ testTarget = "--show-details=streaming";+ doCheck = true;++ # there can be any other modifications:+ #+ # enableSharedExecutables = false;+ # enableSeparateDataOutput = true;+ # enableSeparateDocOutput = true;+ # enableLibraryProfiling = false;+ # isLibrary = true;+ # doHaddock = false;+ })+ ```+++# Tricks++1. In order to substitute the parameters we require all the parameters to have+`Arbitrary` instance, however it's not always possible as not all parameters may+have a sane instance. In such cases it worth mapping the query input. It can be+done by applying `lmap` from `profunctors` package:+
+ hasql-explain-tests.cabal view
@@ -0,0 +1,57 @@+cabal-version: 2.4+name: hasql-explain-tests+version: 0.1.0.0+synopsis: Hasql queries testing interface+homepage: https://github.com/cheopslab/hasql-explain-tests+bug-reports: https://github.com/cheopslab/hasql-explain-tests/issues+license: MPL-2.0+license-file: LICENSE+author: Alexander Vershilov+maintainer: alexander.vershilov@sirius.online++copyright: (C) Talant i uspeh, 2022 +category: Testing+extra-source-files: CHANGELOG.md+ Readme.markdown++description: The library provides an interface to test queries+ in the projects that are using hasql library. Hasql library+ is very low-level and allows you to use all the features of Postgres+ at the cost of losing type safety. This package is intended to+ fill the gap and simplify testing the project by providing helper functions+ for basic queries tests that do not depend on the concrete application logic.+++library+ exposed-modules: Test.Database.Hasql+ default-extensions:+ ImportQualifiedPost+ LambdaCase+ OverloadedStrings+ build-depends: base ^>=4.14.3.0,+ bytestring <1,+ hasql >= 1.0,+ tmp-postgres >= 1.34,+ QuickCheck >= 2.0,+ profunctors ^>= 5.6,+ hspec+ hs-source-dirs: src+ default-language: Haskell2010++test-suite hasql-explain-tests-simple+ default-language: Haskell2010+ type: exitcode-stdio-1.0+ hs-source-dirs: test+ main-is: simple.hs+ default-extensions:+ OverloadedStrings+ build-depends: base ^>=4.14.3.0,+ hasql-explain-tests,+ tasty, + tasty-hunit,+ hasql+++source-repository head+ type: git+ location: https://github.com/cheopslab/hasql-explain-tests
+ src/Test/Database/Hasql.hs view
@@ -0,0 +1,152 @@+-- |+-- An interface for testing @hasql@ queries. As @hasql@ is a pretty low-level+-- library and does not provide additional checks in compile time we are +-- interested if the queries are well-formed from the database point of view.+-- +-- This library provides a number of tests that helps to check that the+-- basic properties are held. In order to run the tests, the library provides+-- helpers for running the temporary database.+--+module Test.Database.Hasql+ ( -- * Running tests+ -- $running-tests+ startupPostgres+ , startupPostgresInit+ , teardownPostgres + , allocateConnection+ , freeConnection+ , InitException(..)+ -- * Explain tests+ -- $explain-tests+ , explain+ ) where++import Control.Exception+import Control.Monad.IO.Class+import Data.ByteString (ByteString)+import Data.Profunctor+import Data.Typeable+import Database.Postgres.Temp qualified as Temp+import Hasql.Connection qualified as HC+import Hasql.Decoders qualified as HD+import Hasql.Session qualified as HS+import Hasql.Statement qualified as HST+import Test.QuickCheck+import Test.Hspec++-- $explain-tests+--+-- Explain tests are the tests that are based on the idea to run+-- @explain@ on the query. It means that if we have some SQL query we run+-- @EXPLAIN $SQL@ and provide some variables. Then we check if this query+-- succeeds.+--+-- If this test passes it guarantees:+--+-- 1. that the query is well-formed and that encoders works.+--+-- However it does not check:+--+-- 1. If encoder works+-- 2. The complexity of the query+-- 3. Locks that the query holds++-- | Runs explain test.+--+-- __Note__ In order to run the query we need to substitute parameters,+-- we chose to pass an arbitrary value (using quickcheck), however some values may+-- miss the arbitrary instance, in such cases one can use 'lmap' to map values from+-- the ones that have this interface. I.e.+--+-- @+-- explain (lmap (\() -> constValue) query)+-- @+-- +explain+ :: (Arbitrary input)+ => HST.Statement input output -- ^ Original statement+ -> HC.Connection -- ^ Connection to the database+ -> Expectation +explain t c = do+ let t' = case t of+ HST.Statement sql enc _dec _ -> HST.Statement ("EXPLAIN " <> sql) enc HD.noResult False+ input <- liftIO $ generate $ resize 2 $ arbitrary+ HS.run (HS.statement input t') c `shouldReturn` Right ()++-- $running-tests+--+-- The library if the test-framework agnostic so it provides only the basic+-- commands that can be used in order to run the tests using differrent frameworks.+--+-- For example, using tasty + tasty-hunit one can do:+-- +-- @+-- import Test.Tasty+-- import Test.Tasty.HUnit+--+-- main = defaultMain $+-- withResource (startupPostgres) (teardownPostgres) $ \mkDb ->+-- withResource (mkDb >>= allocateConnection) (freeConnection) $ \conn ->+-- tests conn+--+-- tests :: IO HC.Connection -> TestGroup+-- tests mkConn = testGroup "explain-tests"+-- [ testCase "select 1" $ mkConn >>= explain select1+-- ]+-- @++-- | Possible exceptions that may happen during the initialization process+data InitException+ = InitException HS.QueryError+ -- ^ Exception during running of the initialization script+ | ConnectException HC.ConnectionError+ -- ^ Can't allocate connection to the local db+ | PostgresStartException Temp.StartError+ -- ^ We have failed to start the temporary postgres.+ deriving (Show, Typeable)++instance Exception InitException++-- | Start and initialize the temporary database using the init script.+--+-- Accepts database initialization script that can contain multiple commands+-- and is run in a separate transaction.+--+-- @throws: In case the database initialization fails throws 'InitException'.+startupPostgres :: ByteString -> IO Temp.DB+startupPostgres init_script = startupPostgresInit script where+ script c = do+ HS.run (HS.sql init_script ) c >>= \case+ Right {} -> pure ()+ Left e -> throwIO $ InitException e++-- | Start and initialize temporary database.+--+-- Accepts database initialization funciton from the user.+--+-- @throws: In case if the database initialization fails throws 'InitException' in+-- addition to any exception that could be thrown by the user function.+startupPostgresInit :: (HC.Connection -> IO ()) -> IO Temp.DB+startupPostgresInit run_init = do+ Temp.start >>= \case+ Left e -> throwIO $ PostgresStartException e+ Right db -> do+ c <- HC.acquire (Temp.toConnectionString db) >>= \case+ Left e -> throwIO $ ConnectException e+ Right c -> pure c+ run_init c+ pure db++-- | Teardown database and associated resources+teardownPostgres :: Temp.DB -> IO ()+teardownPostgres = Temp.stop++-- | Allocates connection to the temporary database+allocateConnection :: Temp.DB -> IO HC.Connection+allocateConnection db = HC.acquire (Temp.toConnectionString db) >>= \case+ Left e -> throwIO $ ConnectException e+ Right conn -> pure conn++-- | Frees connection to the temporary database+freeConnection :: HC.Connection -> IO ()+freeConnection = HC.release
+ test/simple.hs view
@@ -0,0 +1,29 @@+module Main (main) where++import Data.Int+import Test.Tasty+import Test.Tasty.HUnit+import Test.Database.Hasql+import Hasql.Connection as HC+import Hasql.Decoders as HD+import Hasql.Encoders as HE+import Hasql.Statement as HST++main :: IO ()+main = defaultMain $+ withResource (startupPostgres init_script) (teardownPostgres) $ \mkDb ->+ withResource (mkDb >>= allocateConnection) (freeConnection) $ \conn ->+ tests conn+ where+ init_script = "create table a (id int8 not null generated always as identity primary key)"++tests :: IO HC.Connection -> TestTree+tests mkConn = testGroup "explain-tests"+ [ testCase "select 1" $ mkConn >>= explain select1+ ]++select1 :: HST.Statement () Int64+select1 = HST.Statement sql encoder decoder False where+ sql = "select 1::int8"+ encoder = HE.noParams+ decoder = HD.singleRow $ HD.column $ HD.nonNullable HD.int8