Add ability to remove storage to chip-tools (#18512)

examples/chip-tool-darwin/BUILD.gn

@@ -48,6 +48,8 @@ executable("chip-tool-darwin") {
     "commands/pairing/Commands.h",
     "commands/pairing/PairingCommandBridge.mm",
     "commands/pairing/PairingDelegateBridge.mm",
+    "commands/storage/Commands.h",
+    "commands/storage/StorageManagementCommand.mm",
     "main.mm",
   ]
 

examples/chip-tool-darwin/commands/common/CHIPCommandStorageDelegate.h

@@ -7,6 +7,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (nullable NSData *)storageDataForKey:(NSString *)key;
 - (BOOL)setStorageData:(NSData *)value forKey:(NSString *)key;
 - (BOOL)removeStorageDataForKey:(NSString *)key;
+- (BOOL)deleteAllStorage;
 @end
 
 NS_ASSUME_NONNULL_END

examples/chip-tool-darwin/commands/common/CHIPCommandStorageDelegate.mm

@@ -17,14 +17,43 @@ BOOL CHIPSetDomainValueForKey(NSString * domain, NSString * key, id value)
     return CFPreferencesAppSynchronize((CFStringRef) domain) == true;
 }
 
-void CHIPRemoveDomainValueForKey(NSString * domain, NSString * key)
+BOOL CHIPRemoveDomainValueForKey(NSString * domain, NSString * key)
 {
     CFPreferencesSetAppValue((CFStringRef) key, nullptr, (CFStringRef) domain);
-    CFPreferencesAppSynchronize((CFStringRef) domain);
+    return CFPreferencesAppSynchronize((CFStringRef) domain) == true;
+}
+
+id CHIPGetDomainKeyList(NSString * domain)
+{
+    id value
+        = (id) CFBridgingRelease(CFPreferencesCopyKeyList((CFStringRef) domain, kCFPreferencesCurrentUser, kCFPreferencesAnyHost));
+    if (value) {
+        return value;
+    }
+    return nil;
+}
+
+BOOL CHIPClearAllDomain(NSString * domain)
+{
+
+    NSArray * allKeys = CHIPGetDomainKeyList(domain);
+    NSLog(@"Removing keys: %@ %@", allKeys, domain);
+    for (id key in allKeys) {
+        NSLog(@"Removing key: %@", key);
+        if (!CHIPRemoveDomainValueForKey(domain, (NSString *) key)) {
+            return NO;
+        }
+    }
+    return YES;
 }
 
 @implementation CHIPToolPersistentStorageDelegate
 
+- (BOOL)deleteAllStorage
+{
+    return CHIPClearAllDomain(kCHIPToolDefaultsDomain);
+}
+
 // MARK: CHIPPersistentStorageDelegate
 
 - (nullable NSData *)storageDataForKey:(NSString *)key
@@ -44,8 +73,7 @@ - (BOOL)removeStorageDataForKey:(NSString *)key
     if (CHIPGetDomainValueForKey(kCHIPToolDefaultsDomain, key) == nil) {
         return NO;
     }
-    CHIPRemoveDomainValueForKey(kCHIPToolDefaultsDomain, key);
-    return YES;
+    return CHIPRemoveDomainValueForKey(kCHIPToolDefaultsDomain, key);
 }
 
 @end

examples/chip-tool-darwin/commands/storage/Commands.h

@@ -0,0 +1,31 @@
+/*
+ *   Copyright (c) 2020 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include "StorageManagementCommand.h"
+#include <commands/common/Commands.h>
+
+void registerCommandsStorage(Commands & commands)
+{
+    const char * clusterName = "storage";
+
+    commands_list clusterCommands = { make_unique<StorageClearAll>() };
+
+    commands.Register(clusterName, clusterCommands);
+}

examples/chip-tool-darwin/commands/storage/StorageManagementCommand.h

@@ -0,0 +1,31 @@
+/*
+ *   Copyright (c) 2022 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include "../common/CHIPCommandBridge.h"
+
+#include <commands/common/Command.h>
+
+class StorageClearAll : public Command
+{
+public:
+    StorageClearAll() : Command("clear-all") {}
+
+    CHIP_ERROR Run() override;
+};

examples/chip-tool-darwin/commands/storage/StorageManagementCommand.mm

@@ -0,0 +1,32 @@
+/*
+ *   Copyright (c) 2022 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#include "../common/CHIPCommandStorageDelegate.h"
+
+#include "StorageManagementCommand.h"
+
+static CHIPToolPersistentStorageDelegate * storage = nil;
+
+CHIP_ERROR StorageClearAll::Run()
+{
+    storage = [[CHIPToolPersistentStorageDelegate alloc] init];
+    if (![storage deleteAllStorage]) {
+        return CHIP_ERROR_INTERNAL;
+    }
+    return CHIP_NO_ERROR;
+}

examples/chip-tool-darwin/main.mm

@@ -20,13 +20,16 @@
 
 #include "commands/pairing/Commands.h"
 
+#include "commands/storage/Commands.h"
+
 #include <zap-generated/cluster/Commands.h>
 #include <zap-generated/test/Commands.h>
 
 int main(int argc, const char * argv[])
 {
     Commands commands;
     registerCommandsPairing(commands);
+    registerCommandsStorage(commands);
     registerCommandsTests(commands);
     registerClusters(commands);
     return commands.Run(argc, (char **) argv);

examples/chip-tool/BUILD.gn

@@ -68,6 +68,7 @@ static_library("chip-tool-utils") {
     "commands/payload/SetupPayloadGenerateCommand.cpp",
     "commands/payload/SetupPayloadParseCommand.cpp",
     "commands/payload/SetupPayloadVerhoeff.cpp",
+    "commands/storage/StorageManagementCommand.cpp",
     "config/PersistentStorage.cpp",
   ]
 

examples/chip-tool/commands/storage/Commands.h

@@ -0,0 +1,31 @@
+/*
+ *   Copyright (c) 2020 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include "StorageManagementCommand.h"
+#include <commands/common/Commands.h>
+
+void registerCommandsStorage(Commands & commands)
+{
+    const char * clusterName = "storage";
+
+    commands_list clusterCommands = { make_unique<StorageClearAll>() };
+
+    commands.Register(clusterName, clusterCommands);
+}

examples/chip-tool/commands/storage/StorageManagementCommand.cpp

@@ -0,0 +1,28 @@
+/*
+ *   Copyright (c) 2022 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#include "../../config/PersistentStorage.h"
+
+#include "StorageManagementCommand.h"
+
+CHIP_ERROR StorageClearAll::Run()
+{
+    PersistentStorage storage;
+    ReturnErrorOnFailure(storage.Init());
+    return storage.SyncClearAll();
+}

examples/chip-tool/commands/storage/StorageManagementCommand.h

@@ -0,0 +1,29 @@
+/*
+ *   Copyright (c) 2022 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ *
+ */
+
+#pragma once
+
+#include <commands/common/Command.h>
+
+class StorageClearAll : public Command
+{
+public:
+    StorageClearAll() : Command("clear-all") {}
+
+    CHIP_ERROR Run() override;
+};

examples/chip-tool/config/PersistentStorage.cpp

@@ -145,6 +145,15 @@ CHIP_ERROR PersistentStorage::SyncDeleteKeyValue(const char * key)
     return CommitConfig(mName);
 }
 
+CHIP_ERROR PersistentStorage::SyncClearAll()
+{
+    ChipLogProgress(chipTool, "Clearing %s storage", kDefaultSectionName);
+    auto section = mConfig.sections[kDefaultSectionName];
+    section.clear();
+    mConfig.sections[kDefaultSectionName] = section;
+    return CommitConfig(mName);
+}
+
 CHIP_ERROR PersistentStorage::CommitConfig(const char * name)
 {
     CHIP_ERROR err = CHIP_NO_ERROR;

examples/chip-tool/config/PersistentStorage.h

@@ -48,6 +48,9 @@ class PersistentStorage : public chip::PersistentStorageDelegate
     // Store local CATs.
     CHIP_ERROR SetCommissionerCATs(const chip::CATValues & cats);
 
+    // Clear all of the persistent storage for running session.
+    CHIP_ERROR SyncClearAll();
+
 private:
     CHIP_ERROR CommitConfig(const char * name);
     inipp::Ini<char> mConfig;

examples/chip-tool/main.cpp

@@ -24,6 +24,7 @@
 #include "commands/interactive/Commands.h"
 #include "commands/pairing/Commands.h"
 #include "commands/payload/Commands.h"
+#include "commands/storage/Commands.h"
 
 #include <zap-generated/cluster/Commands.h>
 #include <zap-generated/test/Commands.h>
@@ -42,6 +43,7 @@ int main(int argc, char * argv[])
     registerCommandsTests(commands, &credIssuerCommands);
     registerCommandsGroup(commands, &credIssuerCommands);
     registerClusters(commands, &credIssuerCommands);
+    registerCommandsStorage(commands);
 
     return commands.Run(argc, argv);
 }