mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-24 16:03:37 +03:00
0922a3bb24
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5451 GitOrigin-RevId: 8847af09a83293c619326d22209289397911bc5a
203 lines
6.9 KiB
Haskell
203 lines
6.9 KiB
Haskell
{-# LANGUAGE QuasiQuotes #-}
|
|
{-# LANGUAGE ViewPatterns #-}
|
|
|
|
-- | Test that when a table is untracked, SQL triggers that were created on the
|
|
-- tables is also removed
|
|
module Test.EventTrigger.EventTriggersMSSQLUntrackTableCleanupSpec (spec) where
|
|
|
|
import Control.Concurrent.Chan qualified as Chan
|
|
import Data.List.NonEmpty qualified as NE
|
|
import Harness.Backend.Sqlserver qualified as Sqlserver
|
|
import Harness.GraphqlEngine qualified as GraphqlEngine
|
|
import Harness.Quoter.Yaml
|
|
import Harness.Test.Fixture qualified as Fixture
|
|
import Harness.Test.Schema (Table (..), table)
|
|
import Harness.Test.Schema qualified as Schema
|
|
import Harness.TestEnvironment (TestEnvironment, stopServer)
|
|
import Harness.Webhook qualified as Webhook
|
|
import Harness.Yaml (shouldBeYaml, shouldReturnYaml)
|
|
import Hasura.Prelude
|
|
import System.Timeout (timeout)
|
|
import Test.HUnit.Base (assertFailure)
|
|
import Test.Hspec (SpecWith, describe, it)
|
|
|
|
--------------------------------------------------------------------------------
|
|
-- Preamble
|
|
|
|
spec :: SpecWith TestEnvironment
|
|
spec =
|
|
Fixture.runWithLocalTestEnvironment
|
|
( NE.fromList
|
|
[ (Fixture.fixture $ Fixture.Backend Fixture.SQLServer)
|
|
{ -- setup the webhook server as the local test environment,
|
|
-- so that the server can be referenced while testing
|
|
Fixture.mkLocalTestEnvironment = webhookServerMkLocalTestEnvironment,
|
|
Fixture.setupTeardown = \testEnv ->
|
|
[ Fixture.SetupAction
|
|
{ Fixture.setupAction = mssqlSetup testEnv,
|
|
Fixture.teardownAction = \_ -> mssqlTeardown testEnv
|
|
}
|
|
]
|
|
}
|
|
]
|
|
)
|
|
tests
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- * Backend
|
|
|
|
-- ** Schema
|
|
|
|
schema :: Text -> [Schema.Table]
|
|
schema authorTableName = [authorsTable authorTableName]
|
|
|
|
authorsTable :: Text -> Schema.Table
|
|
authorsTable tableName =
|
|
(table tableName)
|
|
{ tableColumns =
|
|
[ Schema.column "id" Schema.TInt,
|
|
Schema.column "name" Schema.TStr
|
|
],
|
|
tablePrimaryKey = ["id"],
|
|
tableData =
|
|
[ [Schema.VInt 1, Schema.VStr "Author 1"],
|
|
[Schema.VInt 2, Schema.VStr "Author 2"]
|
|
]
|
|
}
|
|
|
|
--------------------------------------------------------------------------------
|
|
-- Tests
|
|
|
|
tests :: Fixture.Options -> SpecWith (TestEnvironment, (GraphqlEngine.Server, Webhook.EventsQueue))
|
|
tests opts = do
|
|
cleanupEventTriggersWhenTableUntracked opts
|
|
|
|
cleanupEventTriggersWhenTableUntracked :: Fixture.Options -> SpecWith (TestEnvironment, (GraphqlEngine.Server, Webhook.EventsQueue))
|
|
cleanupEventTriggersWhenTableUntracked opts =
|
|
describe "untrack a table with event triggers should remove the SQL triggers created on the table" do
|
|
it "check: inserting a new row invokes a event trigger" $
|
|
\(testEnvironment, (_, (Webhook.EventsQueue eventsQueue))) -> do
|
|
let insertQuery =
|
|
[yaml|
|
|
type: mssql_run_sql
|
|
args:
|
|
source: mssql
|
|
sql: "INSERT INTO authors (id, name) values (3, N'john')"
|
|
|]
|
|
|
|
expectedResponse =
|
|
[yaml|
|
|
result_type: CommandOk
|
|
result: null
|
|
|]
|
|
|
|
expectedEventPayload =
|
|
[yaml|
|
|
old: null
|
|
new:
|
|
name: john
|
|
id: 3
|
|
|]
|
|
|
|
-- Insert a row into the table with event trigger
|
|
shouldReturnYaml
|
|
opts
|
|
(GraphqlEngine.postV2Query 200 testEnvironment insertQuery)
|
|
expectedResponse
|
|
|
|
-- Check if there was a payload generated due to the insert statement
|
|
eventPayload <-
|
|
-- wait for the event for a maximum of 5 seconds
|
|
timeout (5 * 1000000) (Chan.readChan eventsQueue)
|
|
>>= (`onNothing` (assertFailure "Event expected, but not fired"))
|
|
|
|
eventPayload `shouldBeYaml` expectedEventPayload
|
|
|
|
it "untrack table, check the SQL triggers are deleted from the table" $
|
|
\(testEnvironment, _) -> do
|
|
let untrackTableQuery =
|
|
[yaml|
|
|
type: mssql_untrack_table
|
|
args:
|
|
source: mssql
|
|
table:
|
|
schema: hasura
|
|
name: authors
|
|
|]
|
|
|
|
untrackTableQueryExpectedResponse = [yaml| message: success |]
|
|
|
|
-- Untracking the table should remove the SQL triggers on the table
|
|
shouldReturnYaml
|
|
opts
|
|
(GraphqlEngine.postMetadata testEnvironment untrackTableQuery)
|
|
untrackTableQueryExpectedResponse
|
|
|
|
let checkIfTriggerExists =
|
|
[yaml|
|
|
type: mssql_run_sql
|
|
args:
|
|
source: mssql
|
|
sql: "SELECT
|
|
(CASE WHEN EXISTS
|
|
( SELECT 1
|
|
FROM sys.triggers tr
|
|
INNER join sys.tables tb on tr.parent_id = tb.object_id
|
|
INNER join sys.schemas s on tb.schema_id = s.schema_id
|
|
WHERE tb.name = 'authors' AND tr.name = 'notify_hasura_insert_author_INSERT' AND s.name = 'hasura'
|
|
)
|
|
THEN CAST(1 AS BIT)
|
|
ELSE CAST(0 AS BIT)
|
|
END) AS 'exists';"
|
|
|]
|
|
|
|
expectedResponse =
|
|
[yaml|
|
|
result_type: TuplesOk
|
|
result:
|
|
- - exists
|
|
- - false
|
|
|]
|
|
|
|
-- If the clean-up did not happen properly this insert query would add
|
|
-- entries to the 'hdb_catalog.event_log' table
|
|
shouldReturnYaml
|
|
opts
|
|
(GraphqlEngine.postV2Query 200 testEnvironment checkIfTriggerExists)
|
|
expectedResponse
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- ** Setup and teardown override
|
|
|
|
mssqlSetup :: (TestEnvironment, (GraphqlEngine.Server, Webhook.EventsQueue)) -> IO ()
|
|
mssqlSetup (testEnvironment, (webhookServer, _)) = do
|
|
Sqlserver.setup (schema "authors") (testEnvironment, ())
|
|
let webhookServerEchoEndpoint = GraphqlEngine.serverUrl webhookServer ++ "/echo"
|
|
GraphqlEngine.postMetadata_ testEnvironment $
|
|
[yaml|
|
|
type: bulk
|
|
args:
|
|
- type: mssql_create_event_trigger
|
|
args:
|
|
name: authors_all
|
|
source: mssql
|
|
table:
|
|
name: authors
|
|
schema: hasura
|
|
webhook: *webhookServerEchoEndpoint
|
|
insert:
|
|
columns: "*"
|
|
|]
|
|
|
|
mssqlTeardown :: (TestEnvironment, (GraphqlEngine.Server, Webhook.EventsQueue)) -> IO ()
|
|
mssqlTeardown (_, (server, _)) = do
|
|
stopServer server
|
|
Sqlserver.dropTable (authorsTable "authors")
|
|
|
|
webhookServerMkLocalTestEnvironment ::
|
|
TestEnvironment -> IO (GraphqlEngine.Server, Webhook.EventsQueue)
|
|
webhookServerMkLocalTestEnvironment _ = do
|
|
Webhook.run
|