{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.IoTDeviceAdvisor.Types.TestCaseScenario
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.IoTDeviceAdvisor.Types.TestCaseScenario where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoTDeviceAdvisor.Types.TestCaseScenarioStatus
import Amazonka.IoTDeviceAdvisor.Types.TestCaseScenarioType
import qualified Amazonka.Prelude as Prelude

-- | Provides test case scenario.
--
-- /See:/ 'newTestCaseScenario' smart constructor.
data TestCaseScenario = TestCaseScenario'
  { -- | Provides test case scenario failure result.
    TestCaseScenario -> Maybe Text
failure :: Prelude.Maybe Prelude.Text,
    -- | Provides the test case scenario status. Status is one of the following:
    --
    -- -   @PASS@: Test passed.
    --
    -- -   @FAIL@: Test failed.
    --
    -- -   @PENDING@: Test has not started running but is scheduled.
    --
    -- -   @RUNNING@: Test is running.
    --
    -- -   @STOPPING@: Test is performing cleanup steps. You will see this
    --     status only if you stop a suite run.
    --
    -- -   @STOPPED@ Test is stopped. You will see this status only if you stop
    --     a suite run.
    --
    -- -   @PASS_WITH_WARNINGS@: Test passed with warnings.
    --
    -- -   @ERORR@: Test faced an error when running due to an internal issue.
    TestCaseScenario -> Maybe TestCaseScenarioStatus
status :: Prelude.Maybe TestCaseScenarioStatus,
    TestCaseScenario -> Maybe Text
systemMessage :: Prelude.Maybe Prelude.Text,
    -- | Provides test case scenario ID.
    TestCaseScenario -> Maybe Text
testCaseScenarioId :: Prelude.Maybe Prelude.Text,
    -- | Provides test case scenario type. Type is one of the following:
    --
    -- -   Advanced
    --
    -- -   Basic
    TestCaseScenario -> Maybe TestCaseScenarioType
testCaseScenarioType :: Prelude.Maybe TestCaseScenarioType
  }
  deriving (TestCaseScenario -> TestCaseScenario -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TestCaseScenario -> TestCaseScenario -> Bool
$c/= :: TestCaseScenario -> TestCaseScenario -> Bool
== :: TestCaseScenario -> TestCaseScenario -> Bool
$c== :: TestCaseScenario -> TestCaseScenario -> Bool
Prelude.Eq, ReadPrec [TestCaseScenario]
ReadPrec TestCaseScenario
Int -> ReadS TestCaseScenario
ReadS [TestCaseScenario]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TestCaseScenario]
$creadListPrec :: ReadPrec [TestCaseScenario]
readPrec :: ReadPrec TestCaseScenario
$creadPrec :: ReadPrec TestCaseScenario
readList :: ReadS [TestCaseScenario]
$creadList :: ReadS [TestCaseScenario]
readsPrec :: Int -> ReadS TestCaseScenario
$creadsPrec :: Int -> ReadS TestCaseScenario
Prelude.Read, Int -> TestCaseScenario -> ShowS
[TestCaseScenario] -> ShowS
TestCaseScenario -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TestCaseScenario] -> ShowS
$cshowList :: [TestCaseScenario] -> ShowS
show :: TestCaseScenario -> String
$cshow :: TestCaseScenario -> String
showsPrec :: Int -> TestCaseScenario -> ShowS
$cshowsPrec :: Int -> TestCaseScenario -> ShowS
Prelude.Show, forall x. Rep TestCaseScenario x -> TestCaseScenario
forall x. TestCaseScenario -> Rep TestCaseScenario x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TestCaseScenario x -> TestCaseScenario
$cfrom :: forall x. TestCaseScenario -> Rep TestCaseScenario x
Prelude.Generic)

-- |
-- Create a value of 'TestCaseScenario' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'failure', 'testCaseScenario_failure' - Provides test case scenario failure result.
--
-- 'status', 'testCaseScenario_status' - Provides the test case scenario status. Status is one of the following:
--
-- -   @PASS@: Test passed.
--
-- -   @FAIL@: Test failed.
--
-- -   @PENDING@: Test has not started running but is scheduled.
--
-- -   @RUNNING@: Test is running.
--
-- -   @STOPPING@: Test is performing cleanup steps. You will see this
--     status only if you stop a suite run.
--
-- -   @STOPPED@ Test is stopped. You will see this status only if you stop
--     a suite run.
--
-- -   @PASS_WITH_WARNINGS@: Test passed with warnings.
--
-- -   @ERORR@: Test faced an error when running due to an internal issue.
--
-- 'systemMessage', 'testCaseScenario_systemMessage' -
--
-- 'testCaseScenarioId', 'testCaseScenario_testCaseScenarioId' - Provides test case scenario ID.
--
-- 'testCaseScenarioType', 'testCaseScenario_testCaseScenarioType' - Provides test case scenario type. Type is one of the following:
--
-- -   Advanced
--
-- -   Basic
newTestCaseScenario ::
  TestCaseScenario
newTestCaseScenario :: TestCaseScenario
newTestCaseScenario =
  TestCaseScenario'
    { $sel:failure:TestCaseScenario' :: Maybe Text
failure = forall a. Maybe a
Prelude.Nothing,
      $sel:status:TestCaseScenario' :: Maybe TestCaseScenarioStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:systemMessage:TestCaseScenario' :: Maybe Text
systemMessage = forall a. Maybe a
Prelude.Nothing,
      $sel:testCaseScenarioId:TestCaseScenario' :: Maybe Text
testCaseScenarioId = forall a. Maybe a
Prelude.Nothing,
      $sel:testCaseScenarioType:TestCaseScenario' :: Maybe TestCaseScenarioType
testCaseScenarioType = forall a. Maybe a
Prelude.Nothing
    }

-- | Provides test case scenario failure result.
testCaseScenario_failure :: Lens.Lens' TestCaseScenario (Prelude.Maybe Prelude.Text)
testCaseScenario_failure :: Lens' TestCaseScenario (Maybe Text)
testCaseScenario_failure = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TestCaseScenario' {Maybe Text
failure :: Maybe Text
$sel:failure:TestCaseScenario' :: TestCaseScenario -> Maybe Text
failure} -> Maybe Text
failure) (\s :: TestCaseScenario
s@TestCaseScenario' {} Maybe Text
a -> TestCaseScenario
s {$sel:failure:TestCaseScenario' :: Maybe Text
failure = Maybe Text
a} :: TestCaseScenario)

-- | Provides the test case scenario status. Status is one of the following:
--
-- -   @PASS@: Test passed.
--
-- -   @FAIL@: Test failed.
--
-- -   @PENDING@: Test has not started running but is scheduled.
--
-- -   @RUNNING@: Test is running.
--
-- -   @STOPPING@: Test is performing cleanup steps. You will see this
--     status only if you stop a suite run.
--
-- -   @STOPPED@ Test is stopped. You will see this status only if you stop
--     a suite run.
--
-- -   @PASS_WITH_WARNINGS@: Test passed with warnings.
--
-- -   @ERORR@: Test faced an error when running due to an internal issue.
testCaseScenario_status :: Lens.Lens' TestCaseScenario (Prelude.Maybe TestCaseScenarioStatus)
testCaseScenario_status :: Lens' TestCaseScenario (Maybe TestCaseScenarioStatus)
testCaseScenario_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TestCaseScenario' {Maybe TestCaseScenarioStatus
status :: Maybe TestCaseScenarioStatus
$sel:status:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioStatus
status} -> Maybe TestCaseScenarioStatus
status) (\s :: TestCaseScenario
s@TestCaseScenario' {} Maybe TestCaseScenarioStatus
a -> TestCaseScenario
s {$sel:status:TestCaseScenario' :: Maybe TestCaseScenarioStatus
status = Maybe TestCaseScenarioStatus
a} :: TestCaseScenario)

testCaseScenario_systemMessage :: Lens.Lens' TestCaseScenario (Prelude.Maybe Prelude.Text)
testCaseScenario_systemMessage :: Lens' TestCaseScenario (Maybe Text)
testCaseScenario_systemMessage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TestCaseScenario' {Maybe Text
systemMessage :: Maybe Text
$sel:systemMessage:TestCaseScenario' :: TestCaseScenario -> Maybe Text
systemMessage} -> Maybe Text
systemMessage) (\s :: TestCaseScenario
s@TestCaseScenario' {} Maybe Text
a -> TestCaseScenario
s {$sel:systemMessage:TestCaseScenario' :: Maybe Text
systemMessage = Maybe Text
a} :: TestCaseScenario)

-- | Provides test case scenario ID.
testCaseScenario_testCaseScenarioId :: Lens.Lens' TestCaseScenario (Prelude.Maybe Prelude.Text)
testCaseScenario_testCaseScenarioId :: Lens' TestCaseScenario (Maybe Text)
testCaseScenario_testCaseScenarioId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TestCaseScenario' {Maybe Text
testCaseScenarioId :: Maybe Text
$sel:testCaseScenarioId:TestCaseScenario' :: TestCaseScenario -> Maybe Text
testCaseScenarioId} -> Maybe Text
testCaseScenarioId) (\s :: TestCaseScenario
s@TestCaseScenario' {} Maybe Text
a -> TestCaseScenario
s {$sel:testCaseScenarioId:TestCaseScenario' :: Maybe Text
testCaseScenarioId = Maybe Text
a} :: TestCaseScenario)

-- | Provides test case scenario type. Type is one of the following:
--
-- -   Advanced
--
-- -   Basic
testCaseScenario_testCaseScenarioType :: Lens.Lens' TestCaseScenario (Prelude.Maybe TestCaseScenarioType)
testCaseScenario_testCaseScenarioType :: Lens' TestCaseScenario (Maybe TestCaseScenarioType)
testCaseScenario_testCaseScenarioType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TestCaseScenario' {Maybe TestCaseScenarioType
testCaseScenarioType :: Maybe TestCaseScenarioType
$sel:testCaseScenarioType:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioType
testCaseScenarioType} -> Maybe TestCaseScenarioType
testCaseScenarioType) (\s :: TestCaseScenario
s@TestCaseScenario' {} Maybe TestCaseScenarioType
a -> TestCaseScenario
s {$sel:testCaseScenarioType:TestCaseScenario' :: Maybe TestCaseScenarioType
testCaseScenarioType = Maybe TestCaseScenarioType
a} :: TestCaseScenario)

instance Data.FromJSON TestCaseScenario where
  parseJSON :: Value -> Parser TestCaseScenario
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TestCaseScenario"
      ( \Object
x ->
          Maybe Text
-> Maybe TestCaseScenarioStatus
-> Maybe Text
-> Maybe Text
-> Maybe TestCaseScenarioType
-> TestCaseScenario
TestCaseScenario'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"failure")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"status")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"systemMessage")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"testCaseScenarioId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"testCaseScenarioType")
      )

instance Prelude.Hashable TestCaseScenario where
  hashWithSalt :: Int -> TestCaseScenario -> Int
hashWithSalt Int
_salt TestCaseScenario' {Maybe Text
Maybe TestCaseScenarioStatus
Maybe TestCaseScenarioType
testCaseScenarioType :: Maybe TestCaseScenarioType
testCaseScenarioId :: Maybe Text
systemMessage :: Maybe Text
status :: Maybe TestCaseScenarioStatus
failure :: Maybe Text
$sel:testCaseScenarioType:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioType
$sel:testCaseScenarioId:TestCaseScenario' :: TestCaseScenario -> Maybe Text
$sel:systemMessage:TestCaseScenario' :: TestCaseScenario -> Maybe Text
$sel:status:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioStatus
$sel:failure:TestCaseScenario' :: TestCaseScenario -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
failure
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TestCaseScenarioStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
systemMessage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
testCaseScenarioId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TestCaseScenarioType
testCaseScenarioType

instance Prelude.NFData TestCaseScenario where
  rnf :: TestCaseScenario -> ()
rnf TestCaseScenario' {Maybe Text
Maybe TestCaseScenarioStatus
Maybe TestCaseScenarioType
testCaseScenarioType :: Maybe TestCaseScenarioType
testCaseScenarioId :: Maybe Text
systemMessage :: Maybe Text
status :: Maybe TestCaseScenarioStatus
failure :: Maybe Text
$sel:testCaseScenarioType:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioType
$sel:testCaseScenarioId:TestCaseScenario' :: TestCaseScenario -> Maybe Text
$sel:systemMessage:TestCaseScenario' :: TestCaseScenario -> Maybe Text
$sel:status:TestCaseScenario' :: TestCaseScenario -> Maybe TestCaseScenarioStatus
$sel:failure:TestCaseScenario' :: TestCaseScenario -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
failure
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TestCaseScenarioStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
systemMessage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
testCaseScenarioId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TestCaseScenarioType
testCaseScenarioType