From ec031378c660fee6650c61c10da3ff0388244e47 Mon Sep 17 00:00:00 2001
From: Carol Yang <clyang@apple.com>
Date: Mon, 23 Jan 2023 13:15:11 -0800
Subject: [PATCH] [OTA] Add a command line option to disable sending of
 NotifyUpdateApplied command (#24575)

---
 .github/.wordlist.txt                                |  1 +
 examples/ota-requestor-app/linux/README.md           |  4 +++-
 examples/ota-requestor-app/linux/main.cpp            | 12 ++++++++++++
 .../ota-requestor/DefaultOTARequestorDriver.cpp      |  5 ++++-
 .../ota-requestor/DefaultOTARequestorDriver.h        |  5 +++++
 5 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
index b1f04c1a849bf4..f7d6f3995dc039 100644
--- a/.github/.wordlist.txt
+++ b/.github/.wordlist.txt
@@ -416,6 +416,7 @@ diffsyms
 dimmable
 dirname
 dirs
+disableNotifyUpdateApplied
 disambiguated
 discoverable
 DispatchEvent
diff --git a/examples/ota-requestor-app/linux/README.md b/examples/ota-requestor-app/linux/README.md
index f14d5fa7cdf094..9cb47171aae555 100644
--- a/examples/ota-requestor-app/linux/README.md
+++ b/examples/ota-requestor-app/linux/README.md
@@ -16,11 +16,13 @@ scripts/examples/gn_build_example.sh examples/ota-requestor-app/linux out/debug
 
 In addition to the general options available to all Linux applications, the
 following command line options are available for the OTA Requestor application.
+Note that these options are for testing purposes.
 
 | Command Line Option                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | -a, --autoApplyImage                                     | If supplied, apply the image immediately after download. Otherwise, the OTA update is complete after image download.                                                                                                                                                                                                                                                                                                                                                                                              |
 | -c, --requestorCanConsent \<true \| false\>              | Value for the RequestorCanConsent field in the QueryImage command. If not supplied, the value is determined by the driver.                                                                                                                                                                                                                                                                                                                                                                                        |
+| -d, --disableNotifyUpdateApplied                         | If supplied, disable sending of the NotifyUpdateApplied command. Otherwise, after successfully loading into the updated image, send the NotifyUpdateApplied command.                                                                                                                                                                                                                                                                                                                                              |
 | -f, --otaDownloadPath \<file path\>                      | If supplied, the OTA image is downloaded to the given fully-qualified file-path. Otherwise, the default location for the downloaded image is at /tmp/test.bin                                                                                                                                                                                                                                                                                                                                                     |
 | -p, --periodicQueryTimeout \<time in seconds\>           | The periodic time interval to wait before attempting to query a provider from the default OTA provider list. If none or zero is supplied, the value is determined by the driver.                                                                                                                                                                                                                                                                                                                                  |
 | -u, --userConsentState \<granted \| denied \| deferred\> | Represents the current user consent status when the OTA Requestor is acting as a user consent delegate. This value is only applicable if value of the UserConsentNeeded field in the QueryImageResponse is set to true. This value is used for the first attempt to download. For all subsequent queries, the value of granted will be used.<li> granted: Authorize OTA requestor to download an OTA image <li> denied: Forbid OTA requestor to download an OTA image <li> deferred: Defer obtaining user consent |
@@ -246,7 +248,7 @@ out/chip-tool pairing onnetwork-long 0x1234567890 20202021 18
 **Issue the AnnounceOTAProvider command**
 
 ```
-out/chip-tool otasoftwareupdaterequestor announce-ota-provider 0xDEADBEEF 0 0 0 0x1234567890 0
+out/chip-tool otasoftwareupdaterequestor announce-otaprovider 0xDEADBEEF 0 0 0 0x1234567890 0
 ```
 
 The OTA Requestor application with node ID 0x1234567890 will process this
diff --git a/examples/ota-requestor-app/linux/main.cpp b/examples/ota-requestor-app/linux/main.cpp
index 174b3d7cd9809b..c957683500ed2f 100644
--- a/examples/ota-requestor-app/linux/main.cpp
+++ b/examples/ota-requestor-app/linux/main.cpp
@@ -70,6 +70,7 @@ bool HandleOptions(const char * aProgram, OptionSet * aOptions, int aIdentifier,
 
 constexpr uint16_t kOptionAutoApplyImage       = 'a';
 constexpr uint16_t kOptionRequestorCanConsent  = 'c';
+constexpr uint16_t kOptionDisableNotify        = 'd';
 constexpr uint16_t kOptionOtaDownloadPath      = 'f';
 constexpr uint16_t kOptionPeriodicQueryTimeout = 'p';
 constexpr uint16_t kOptionUserConsentState     = 'u';
@@ -81,10 +82,12 @@ uint32_t gWatchdogTimeoutSec      = 0;
 chip::Optional<bool> gRequestorCanConsent;
 static char gOtaDownloadPath[kMaxFilePathSize] = "/tmp/test.bin";
 bool gAutoApplyImage                           = false;
+bool gSendNotifyUpdateApplied                  = true;
 
 OptionDef cmdLineOptionsDef[] = {
     { "autoApplyImage", chip::ArgParser::kNoArgument, kOptionAutoApplyImage },
     { "requestorCanConsent", chip::ArgParser::kArgumentRequired, kOptionRequestorCanConsent },
+    { "disableNotifyUpdateApplied", chip::ArgParser::kNoArgument, kOptionDisableNotify },
     { "otaDownloadPath", chip::ArgParser::kArgumentRequired, kOptionOtaDownloadPath },
     { "periodicQueryTimeout", chip::ArgParser::kArgumentRequired, kOptionPeriodicQueryTimeout },
     { "userConsentState", chip::ArgParser::kArgumentRequired, kOptionUserConsentState },
@@ -92,6 +95,7 @@ OptionDef cmdLineOptionsDef[] = {
     {},
 };
 
+// Options for various test scenarios
 OptionSet cmdLineOptions = {
     HandleOptions, cmdLineOptionsDef, "PROGRAM OPTIONS",
     "  -a, --autoApplyImage\n"
@@ -100,6 +104,9 @@ OptionSet cmdLineOptions = {
     "  -c, --requestorCanConsent <true | false>\n"
     "       Value for the RequestorCanConsent field in the QueryImage command.\n"
     "       If not supplied, the value is determined by the driver.\n"
+    "  -d, --disableNotifyUpdateApplied\n"
+    "       If supplied, disable sending of the NotifyUpdateApplied command.\n"
+    "       Otherwise, after successfully loading into the updated image, send the NotifyUpdateApplied command.\n"
     "  -f, --otaDownloadPath <file path>\n"
     "       If supplied, the OTA image is downloaded to the given fully-qualified file-path.\n"
     "       Otherwise, the default location for the downloaded image is at /tmp/test.bin\n"
@@ -181,6 +188,7 @@ static void InitOTARequestor(void)
 
     // Watchdog timeout can be set any time before a query image is sent
     gRequestorUser.SetWatchdogTimeout(gWatchdogTimeoutSec);
+    gRequestorUser.SetSendNotifyUpdateApplied(gSendNotifyUpdateApplied);
 
     gRequestorStorage.Init(chip::Server::GetInstance().GetPersistentStorage());
     gRequestorCore.Init(chip::Server::GetInstance(), gRequestorStorage, gRequestorUser, gDownloader);
@@ -313,6 +321,10 @@ bool HandleOptions(const char * aProgram, OptionSet * aOptions, int aIdentifier,
     case kOptionWatchdogTimeout:
         gWatchdogTimeoutSec = static_cast<uint32_t>(strtoul(aValue, NULL, 0));
         break;
+    case kOptionDisableNotify:
+        // By default, NotifyUpdateApplied should always be sent. In the presence of this option, disable sending of the command.
+        gSendNotifyUpdateApplied = false;
+        break;
     default:
         ChipLogError(SoftwareUpdate, "%s: INTERNAL ERROR: Unhandled option: %s\n", aProgram, aName);
         retval = false;
diff --git a/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.cpp b/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.cpp
index 412ce1573d763d..02ffbf982814c3 100644
--- a/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.cpp
+++ b/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.cpp
@@ -76,7 +76,10 @@ void DefaultOTARequestorDriver::Init(OTARequestorInterface * requestor, OTAImage
                 return;
             }
 
-            mRequestor->NotifyUpdateApplied();
+            if (mSendNotifyUpdateApplied)
+            {
+                mRequestor->NotifyUpdateApplied();
+            }
         });
     }
     else if ((mRequestor->GetCurrentUpdateState() != OTAUpdateStateEnum::kIdle))
diff --git a/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.h b/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.h
index 4a643da36e1251..749a2a6497a661 100644
--- a/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.h
+++ b/src/app/clusters/ota-requestor/DefaultOTARequestorDriver.h
@@ -52,6 +52,9 @@ class DefaultOTARequestorDriver : public OTARequestorDriver
         }
     }
 
+    // Specify whether to send notify update applied after successful update
+    void SetSendNotifyUpdateApplied(bool sendNotify) { mSendNotifyUpdateApplied = sendNotify; }
+
     // Restart the periodic query timer
     void RekickPeriodicQueryTimer(void);
 
@@ -116,6 +119,8 @@ class DefaultOTARequestorDriver : public OTARequestorDriver
     uint8_t mProviderRetryCount = 0;
     // Track query image retry count on invalid session error
     uint8_t mInvalidSessionRetryCount = 0;
+    // Track whether to send notify update applied after successful update
+    bool mSendNotifyUpdateApplied = true;
 };
 
 } // namespace DeviceLayer