Add command line for --attempt and --max-attempts.

Author: yruslan

README.md

@@ -3537,6 +3537,8 @@ Execution options:
 | --undercover               | `--undercover`              | If specified, Pramen will not update bookkeeper so any changes caused by the pipeline won't be recorded. Useful for re-running historical transformations without triggering execution of the rest of the pipeline. |
 | --use-lock <true \| false> | `--use-lock true`           | If true (default) a lock will be used to protect against parallel writes to the same partition. Bookkeeping storage or database will be used for locking across pipelines.                                          |
 | --skip-locked              | `--skip-locked`             | If specified, jobs that are already running (holding a lock) will be skipped. Otherwise, an error will be thrown.                                                                                                   |
+| --attempt                  | `--attempt 2`               | Specifies attempt number for the pipeline. This is only for notification purposes. Used together with `--max-attempts`.                                                                                             |
+| --max-attempts             | `--max-attempts 5`          | Specifies the number of attempts for the pipeline. This is only for notification purposes.                                                                                                                          |
 
 ### Command line examples
 

pramen/core/src/main/scala/za/co/absa/pramen/core/cmd/CmdLineConfig.scala

@@ -46,7 +46,9 @@ case class CmdLineConfig(
                           inverseOrder: Option[Boolean] = None,
                           verbose: Option[Boolean] = None,
                           overrideLogLevel: Option[String] = None,
-                          logEffectiveConfig: Option[Boolean] = None
+                          logEffectiveConfig: Option[Boolean] = None,
+                          attempt: Option[Int] = None,
+                          maxAttempts: Option[Int] = None
                         )
 
 object CmdLineConfig {
@@ -129,6 +131,12 @@ object CmdLineConfig {
     for (logEffectiveConfig <- cmd.logEffectiveConfig)
       accumulatedConfig = accumulatedConfig.withValue(LOG_EFFECTIVE_CONFIG, ConfigValueFactory.fromAnyRef(logEffectiveConfig))
 
+    for (attempt <- cmd.attempt)
+      accumulatedConfig = accumulatedConfig.withValue(ATTEMPT, ConfigValueFactory.fromAnyRef(attempt))
+
+    for (maxAttempts <- cmd.maxAttempts)
+      accumulatedConfig = accumulatedConfig.withValue(MAX_ATTEMPTS, ConfigValueFactory.fromAnyRef(maxAttempts))
+
     accumulatedConfig
   }
 
@@ -206,6 +214,14 @@ object CmdLineConfig {
       config.copy(dryRun = Some(true)))
       .text("If true, no actual data processing will be done.")
 
+    opt[Int]("attempt").optional().action((value, config) =>
+        config.copy(attempt = Option(value)))
+      .text("The attempt number for notification purposes (default 1).")
+
+    opt[Int]("max-attempts").optional().action((value, config) =>
+        config.copy(maxAttempts = Option(value)))
+      .text("The maximum number of attempts for notification purposes (default 1).")
+
     opt[Boolean]("use-lock").optional().action((value, config) =>
       config.copy(useLock = Option(value)))
       .text("If true (default) a lock is used when writing to a table")

pramen/core/src/test/scala/za/co/absa/pramen/core/cmd/CmdLineConfigSuite.scala

@@ -99,6 +99,13 @@ class CmdLineConfigSuite extends AnyWordSpec {
         assert(cmd.get.checkOnlyNewData.get)
       }
 
+      "parse attempts" in {
+        val cmd = CmdLineConfig.parseCmdLine(Array("--workflow", "dummy.config", "--attempt", "2", "--max-attempts", "5"))
+        assert(cmd.nonEmpty)
+        assert(cmd.get.maxAttempts.get == 5)
+        assert(cmd.get.attempt.get == 2)
+      }
+
       "return None when wrong date format is passed to --date" in {
         val cmd = CmdLineConfig.parseCmdLine(Array("--workflow", "dummy.config", "--date", "16/08/2020"))
         assert(cmd.isEmpty)
@@ -271,6 +278,17 @@ class CmdLineConfigSuite extends AnyWordSpec {
       assert(config.getBoolean(UNDERCOVER))
     }
 
+    "return the modified config with attempts" in {
+      val cmd = CmdLineConfig.parseCmdLine(Array("--workflow", "dummy.config", "--attempt", "2", "--max-attempts", "5"))
+      val config = CmdLineConfig.applyCmdLineToConfig(populatedConfig, cmd.get)
+
+      assert(config.hasPath(ATTEMPT))
+      assert(config.getInt(ATTEMPT) == 2)
+      assert(config.hasPath(MAX_ATTEMPTS))
+      assert(config.getInt(MAX_ATTEMPTS) == 5)
+    }
+
+
     "return the modified config if useLock = true" in {
       val cmd = CmdLineConfig.parseCmdLine(Array("--workflow", "dummy.config", "--use-lock", "true"))
       val config = CmdLineConfig.applyCmdLineToConfig(populatedConfig, cmd.get)