Improvements to .NET metadata management scripts (#925)

ZackAllen · web-flow · commit 99a56b8501f5 · 2021-10-06T16:59:49.000-07:00
* Simplified metadata process script

* Fixed warning in readme copy

* Added script for calling readme copy and metadata sync

* Improvements to readme_copy

* Status prints for sample_sync

* Fixed issue with android layout relative filepaths

* Fix for edge case with display device location

* Previously unsynced local server readme change

* Fixed Local server map image layer readme
diff --git a/src/Android/Xamarin.Android/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/Android/Xamarin.Android/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -33,4 +33,4 @@
         "DisplayDeviceLocation.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/src/Forms/Shared/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/Forms/Shared/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -37,4 +37,4 @@
         "DisplayDeviceLocation.xaml.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/src/UWP/ArcGISRuntime.UWP.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/UWP/ArcGISRuntime.UWP.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -34,4 +34,4 @@
         "DisplayDeviceLocation.xaml.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/src/WPF/ArcGISRuntime.WPF.Viewer/Samples/Local Server/LocalServerMapImageLayer/readme.md b/src/WPF/ArcGISRuntime.WPF.Viewer/Samples/Local Server/LocalServerMapImageLayer/readme.md
@@ -17,7 +17,7 @@ The Local Server and local map service will automatically be started and, once r
 1. Create and run a local server with `LocalServer.Instance`.
 2. Start the server asynchronously with `server.StartAsync()`.
 3. Create and run a local service, example of running a `LocalMapService`.
-    1. Instantiate `LocalMapService(Url)` to create a local map service with the given URL path to the map package (`mpk` file).
+    1. Instantiate `LocalMapService(Url)` to create a local map service with the given URL path to the map package (`mpkx` file).
     2. Start the service asynchronously with `LocalMapService.StartAsync()`. The service is added to the Local Server automatically.
 4. Create an ArcGIS map image layer from local map service.
    1. Create a `ArcGISMapImageLayer(Url)` from local map service url provided by the `LocalMapService.Url` property.
@@ -44,4 +44,4 @@ Local Server can be downloaded for Windows and Linux platforms from the [develop
 
 ## Tags
 
-image, layer, local, offline, server
+image, layer, local, offline, server
diff --git a/src/WPF/ArcGISRuntime.WPF.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/WPF/ArcGISRuntime.WPF.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -34,4 +34,4 @@
         "DisplayDeviceLocation.xaml.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/src/WinUI/ArcGISRuntime.WinUI.Viewer/Samples/Local Server/LocalServerMapImageLayer/readme.md b/src/WinUI/ArcGISRuntime.WinUI.Viewer/Samples/Local Server/LocalServerMapImageLayer/readme.md
@@ -23,7 +23,7 @@ The Local Server and local map service will automatically be started and, once r
    1. Create a `ArcGISMapImageLayer(Url)` from local map service url provided by the `LocalMapService.Url` property.
    2. Add the layer to the map's operational layers. 
    3. Wait for the layer to load with `await myImageLayer.LoadAsync()`
-   4. Set the map view extent to the layer full extent.
+   4. Set the map view's extent to the layer's full extent.
 
 ## Relevant API
 
@@ -44,4 +44,4 @@ Local Server can be downloaded for Windows and Linux platforms from the [develop
 
 ## Tags
 
-image, layer, local, offline, server
+image, layer, local, offline, server
diff --git a/src/WinUI/ArcGISRuntime.WinUI.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/WinUI/ArcGISRuntime.WinUI.Viewer/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -34,4 +34,4 @@
         "DisplayDeviceLocation.xaml.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/src/iOS/Xamarin.iOS/Samples/Location/DisplayDeviceLocation/readme.metadata.json b/src/iOS/Xamarin.iOS/Samples/Location/DisplayDeviceLocation/readme.metadata.json
@@ -33,4 +33,4 @@
         "DisplayDeviceLocation.cs"
     ],
     "title": "Display device location with autopan modes"
-}
+}
diff --git a/tools/metadata_tools/process_metadata.py b/tools/metadata_tools/process_metadata.py
@@ -193,26 +193,16 @@ def update_attribute(sample, sample_dir):
 
 def main():
     '''
-    Usage: python process_metadata.py {operation} {path_to_samples (ends in src)} {path_to_secondary}
-    Operations: toc; secondary path is empty
-                improve; secondary path is common readme
-                attributes; keep attributes in code in sync with readme
-                sync; keep metadata in sync with readme
+    Usage: python process_metadata.py {path_to_samples (ends in src)} (optional)
+        Location of script being run will be used for a relative path if path to samples is not specified.
     '''
 
-    if len(sys.argv) < 3:
-        print("Usage: python process_metadata.py {operation} {path_to_samples (ends in src)} {path_to_secondary}")
-        print("Operations are toc, improve, attributes, and sync; secondary path is path to common readme source for the improve operation.")
-        return
-
-    operation = sys.argv[1]        
-    sample_root = sys.argv[2]
-    common_dir_path = ""
-    if operation == "improve":
-        if len(sys.argv) < 4:
-            print("Usage: python process_metadata.py improve {path_to_samples (ends in src)} {path_to_readme_source}")
-            return
-        common_dir_path = sys.argv[3]
+    if len(sys.argv) < 2:
+        # get the location of the samples relative to this script in the tools folder
+        script_location = os.path.dirname(os.path.realpath(__file__))
+        sample_root = os.path.abspath(os.path.join(script_location, "..", "..", "src"))
+    else:
+        sample_root = sys.argv[1]
 
     for platform in ["UWP", "WPF", "Android", "Forms", "iOS", "FormsAR", "WinUI"]:
         # make a list of samples, so that build_all_csproj.bat can be produced
@@ -234,27 +224,28 @@ def main():
                 if platform == "FormsAR":
                     sample.category = "Augmented reality"
                 sample.populate_snippets_from_folder(platform, path_to_readme)
-                if operation == "improve":
-                    sample.try_replace_with_common_readme(platform, common_dir_path, path_to_readme)
-                if operation in ["improve", "sync"]:
-                    # read existing packages from metadata
-                    path_to_json = os.path.join(r, sample_dir, "readme.metadata.json")
-                    if os.path.exists(path_to_json):
-                        metadata_based_sample = sample_metadata()
-                        metadata_based_sample.populate_from_json(path_to_json)
-                        sample.nuget_packages = metadata_based_sample.nuget_packages
-                    sample.resync_nuget_packages(platform)
-                    sample.flush_to_json(path_to_json)
-                if operation == "attributes":
-                    update_attribute(sample, os.path.join(r, sample_dir))
+
+                # read existing packages from metadata
+                path_to_json = os.path.join(r, sample_dir, "readme.metadata.json")
+                if os.path.exists(path_to_json):
+                    metadata_based_sample = sample_metadata()
+                    metadata_based_sample.populate_from_json(path_to_json)
+                    sample.nuget_packages = metadata_based_sample.nuget_packages
+                sample.resync_nuget_packages(platform)
+                sample.flush_to_json(path_to_json)
+
+                # update attributes in the sample code files
+                update_attribute(sample, os.path.join(r, sample_dir))
+
                 list_of_sample_dirs.append(sample_dir)
+
                 # track samples in each category to enable TOC generation
                 if sample.category in list_of_samples.keys():
                     list_of_samples[sample.category].append(sample)
                 else:
                     list_of_samples[sample.category] = [sample]
         # write out samples TOC
-        if operation in ["toc", "improve", "sync"] and platform != "FormsAR":
+        if platform != "FormsAR":
             write_samples_toc(get_platform_samples_root(platform, sample_root), get_relative_path_to_samples_from_platform_root(platform), list_of_samples)
     return
 
diff --git a/tools/metadata_tools/sample_metadata.py b/tools/metadata_tools/sample_metadata.py
@@ -108,6 +108,9 @@ def populate_from_readme(self, platform, path_to_readme):
         redirect_string = f"/net/latest/{real_platform.lower()}/sample-code/{self.formal_name.lower()}.htm"
         self.redirect_from.append(redirect_string)
 
+        if self.formal_name == "DisplayDeviceLocation":
+            self.redirect_from.append(f"/net/{real_platform.lower()}/sample-code/display-device-location/")
+
         # category is the name of the folder containing the sample folder
         self.category = pathparts[-3]
 
@@ -424,7 +427,7 @@ def populate_snippets_from_folder(self, platform, path_to_readme):
         # populate files in the directory
         sample_dir = os.path.split(path_to_readme)[0]
         for file in os.listdir(sample_dir):
-            if os.path.splitext(file)[1] in [".axml", ".xaml", ".cs"]:
+            if os.path.splitext(file)[1] in [".axml", ".xaml", ".cs", ".xml"]:
                 self.source_files.append(file)        
             # populate AXML layouts for Android
             if platform == "Android" and os.path.splitext(file)[1] == ".cs":
@@ -444,10 +447,13 @@ def populate_snippets_from_folder(self, platform, path_to_readme):
                         layout_name = line.split("Layout.")[1].strip().strip(";").strip(", null)")
                     if layout_name is not None:
                         # determine if the file ending is .xml
-                        if (os.path.exists(os.path.join("..", "..", "src", "Android", "Xamarin.Android", "Resources", "layout", f"{layout_name}.xml"))):
+                        if (os.path.exists(os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "..", "src", "Android", "Xamarin.Android", "Resources", "layout", f"{layout_name}.xml"))):
                             ending = ".xml"
-                        else:
+                        elif (os.path.exists(os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "..", "src", "Android", "Xamarin.Android", "Resources", "layout", f"{layout_name}.axml"))):
                             ending = ".axml"
+                        else:
+                            print(f"Couldnt find layout file for sample {layout_name}")
+                            continue
                         # add the file path to the snippets list
                         self.source_files.append(f"../../../Resources/layout/{layout_name}{ending}")
         # Manually add JoystickSeekBar control on Android for AR only
@@ -469,7 +475,7 @@ def rewrite_files_in_place(source_dir, replacements_dict):
             for sample_file_name in f:
                 sample_file_fullpath = os.path.join(r, sample_file_name)
                 extension = os.path.splitext(sample_file_fullpath)[1]
-                if extension in [".cs", ".xaml", ".sln", ".slntemplate", ".md", ".csproj", ".shproj", ".axml"]:
+                if extension in [".cs", ".xaml", ".sln", ".slntemplate", ".md", ".csproj", ".shproj", ".axml", ".xml"]:
                     # open file, read into string
                     original_contents = safe_read_contents(sample_file_fullpath)
                     # make replacements
diff --git a/tools/readme_copy/readme_copy.py b/tools/readme_copy/readme_copy.py
@@ -27,42 +27,55 @@ def replace_readmes(category, formal_name, sample_root):
         wpf_file = open(wpf_path, "r")
         wpfcontent = wpf_file.read()
         wpf_file.close()
-        print(f"{formal_name} read from WPF")
+    except OSError as e:
+        print(f"File: {formal_name} Error: {e.strerror} WPF read error")
+
+    # Loop through the other platforms.
+    plats = ["UWP", "Android", "iOS", "Forms", "WinUI"]
+    for platform in plats:
+        # Skip local server for non WinUI platforms.
+        if not platform == "WinUI" and category == "Local Server":
+            continue
+
+        # Copy the original WPF text into a new string
+        platformcontent = copy.copy(wpfcontent)
 
-        # Loop through the other platforms.
-        plats = ["UWP", "Android", "iOS", "Forms", "WinUI"]
-        for platform in plats:
-            # Copy the original WPF text into a new string
-            platformcontent = copy.copy(wpfcontent)
+        # Fix the guide doc url for the platform
+        platformcontent = platformcontent.replace("wpf/guide", str.lower(platform)+"/guide")
+        platformcontent = platformcontent.replace("wpf/sample-code/", str.lower(platform)+"/sample-code/")
 
-            # Fix the guide doc url for the platform
-            platformcontent = platformcontent.replace("wpf/guide", str.lower(platform)+"/guide")
-            platformcontent = platformcontent.replace("wpf/sample-code/", str.lower(platform)+"/sample-code/")
-            #platformcontent = platformcontent.replace("oldlink", "newlink")
+        # For other changes that need to be made.
+        #platformcontent = platformcontent.replace("oldlink", "newlink")
 
-            # Change `click` to `tap` for mobile platforms
-            if  not platform == "UWP" and not platform == "WinUI":
-                platformcontent = platformcontent.replace("click ", "tap ")
-                platformcontent = platformcontent.replace("Click ", "Tap ")
+        # Change `click` to `tap` for mobile platforms
+        if  not platform == "UWP" and not platform == "WinUI":
+            platformcontent = platformcontent.replace("click ", "tap ")
+            platformcontent = platformcontent.replace("Click ", "Tap ")
 
+        try:
             # Write the WPF readme to other platform
             platform_path = os.path.join(get_platform_samples_root(platform, sample_root), category, formal_name, ("readme.md"))
             with open(platform_path, "r+") as file:
                 file.seek(0)
                 file.write(platformcontent)
                 file.truncate()
-                print(f"{formal_name} written to {platform}")
-    except OSError as e:
-        print(e.errno)
+        except OSError as e:
+            print(f"File: {formal_name} Error: {e.strerror} Platform: {platform}")
 def main():
-    if len(sys.argv) is 4:
+    if len(sys.argv) == 4:
         # Get the user arguments.
         category = sys.argv[1]
         formal_name = sys.argv[2]        
         sample_root = sys.argv[3]
         replace_readmes(category, formal_name, sample_root)
-    elif len(sys.argv) is 2:
-        sample_root = sys.argv[1]
+    elif len(sys.argv) <= 2:
+
+        if len(sys.argv) == 1:
+            # get the location of the samples relative to this script in the tools folder
+            script_location = os.path.dirname(os.path.realpath(__file__))
+            sample_root = os.path.abspath(os.path.join(script_location, "..", "..", "src"))
+        else:
+            sample_root = sys.argv[1]
         for category in os.listdir(get_platform_samples_root("WPF", sample_root)):
             for sample in os.listdir( os.path.join(get_platform_samples_root("WPF", sample_root), category) ):
                 replace_readmes(category, sample, sample_root)
@@ -71,6 +84,5 @@ def main():
         print("Usage for all samples: python readme_copy.py {path_to_samples (ends in src)}")
         return
 
-
 if __name__=="__main__":
     main()
diff --git a/tools/sample_sync.py b/tools/sample_sync.py
@@ -0,0 +1,25 @@
+import sys
+import subprocess
+import os
+
+def main():
+    '''
+    Usage: python sample_sync.py 
+    '''
+
+    script_location = os.path.dirname(os.path.realpath(__file__))
+    readme_script_folder = os.path.abspath(os.path.join(script_location, "readme_copy"))
+    readme_script_path = os.path.join(readme_script_folder, "readme_copy.py")
+    metadata_script_folder = os.path.abspath(os.path.join(script_location, "metadata_tools"))
+    metadata_script_path = os.path.join(metadata_script_folder, "process_metadata.py")
+
+    print("Copying readmes")
+    subprocess.run(["python", readme_script_path])
+
+    print("Updating metadata")
+    subprocess.run(["python", metadata_script_path])
+
+    return
+
+if __name__ == "__main__":
+    main()
