Merge pull request #165 from epics-containers/fix-extract-assets

allow globbed extras

src/ibek/ioc_cmds/assets.py

@@ -35,7 +35,13 @@ def move_file(src: Path, dest: Path, binary: List[str]):
         subprocess.call(["bash", "-c", cmd])
 
 
-def extract_assets(destination: Path, source: Path, extras: List[Path], defaults: bool):
+def extract_assets(
+    destination: Path,
+    source: Path,
+    extras: List[Path],
+    defaults: bool,
+    dry_run: bool = False,
+):
     """
     extract and copy runtime assets from a completed developer stage container
     """
@@ -82,13 +88,19 @@ def extract_assets(destination: Path, source: Path, extras: List[Path], defaults
             src = module / asset
             if src.exists():
                 dest_file = destination_module / asset.relative_to(module)
-                move_file(src, dest_file, binary)
+                if dry_run:
+                    typer.echo(f"Would move {src} to {dest_file} with {binary}")
+                else:
+                    move_file(src, dest_file, binary)
 
     extra_files = default_assets + extras
     for asset in extra_files:
         src = source / asset
         if src.exists():
             dest_file = destination / asset.relative_to("/")
-            move_file(src, dest_file, binary)
+            if dry_run:
+                typer.echo(f"Would move extra asset {src} to {dest_file} with {binary}")
+            else:
+                move_file(src, dest_file, binary)
         else:
             raise RuntimeError(f"extra runtime asset {src} missing")

src/ibek/ioc_cmds/commands.py

@@ -83,12 +83,13 @@ def extract_runtime_assets(
         ...,
         help="The root folder to extract assets into",
     ),
+    extras: List[Path] = typer.Argument(None, help="list of files to also extract"),
     source: Path = typer.Option(
         Path("/epics"),
         help="The root folder to extract assets from",
     ),
-    extras: List[Path] = typer.Option(None, help="list of files to also extract"),
     defaults: bool = typer.Option(True, help="copy the default assets"),
+    dry_run: bool = typer.Option(False, help="show what would happen"),
 ):
     """
     Find all the runtime assets in an EPICS installation and copy them to a
@@ -97,4 +98,4 @@ def extract_runtime_assets(
     This should be performed in a throw away container stage (runtime_prep)
     as it is destructive of the source folder, because it uses move for speed.
     """
-    extract_assets(destination, source, extras, defaults)
+    extract_assets(destination, source, extras, defaults, dry_run)

src/ibek/runtime_cmds/commands.py

@@ -122,7 +122,9 @@ def generate_pvi(ioc: IOC) -> Tuple[List[IndexEntry], List[Tuple[Database, Entit
                 formatted_pvi_devices.append(device_name)
 
         if entity_pvi.index:
-            index_entries.append(IndexEntry(device_name, device_bob.name, macros))
+            index_entries.append(
+                IndexEntry(label=device_name, ui=device_bob.name, macros=macros)
+            )
 
     return index_entries, databases
 

src/ibek/support_cmds/commands.py

@@ -254,7 +254,8 @@ def generate_links(
     support_globals = folder / ".." / IBEK_GLOBALS
 
     symlink_files(folder, SUPPORT_YAML_PATTERN, IBEK_DEFS)
-    symlink_files(support_globals, SUPPORT_YAML_PATTERN, IBEK_DEFS)
+    if support_globals.exists():
+        symlink_files(support_globals, SUPPORT_YAML_PATTERN, IBEK_DEFS)
     symlink_files(folder, PVI_YAML_PATTERN, PVI_DEFS)
 
 

tests/generate_samples.sh

@@ -19,7 +19,7 @@ mkdir -p outputs
 set -ex
 
 mkdir -p epics/pvi-defs
-cp support/simple.pvi.device.yaml  epics/pvi-defs/simple.pvi.device.yaml
+cp support/simple.pvi.device.yaml  epics/pvi-defs/Simple.pvi.device.yaml
 
 echo making the support yaml schema
 ibek support generate-schema --output schemas/ibek.support.schema.json

tests/samples/outputs/index.bob

@@ -27,7 +27,7 @@
   </widget>
   <widget type="label" version="2.0.0">
     <name>Label</name>
-    <text>imple</text>
+    <text>Simple</text>
     <x>23</x>
     <y>30</y>
     <width>115</width>
@@ -37,15 +37,15 @@
     <name>OpenDisplay</name>
     <actions>
       <action type="open_display">
-        <file>simple.pvi.bob</file>
+        <file>Simple.pvi.bob</file>
         <target>tab</target>
         <description>Open Display</description>
         <macros>
           <prefix>IBEK-MO-TST-01::</prefix>
         </macros>
       </action>
     </actions>
-    <text>imple</text>
+    <text>Simple</text>
     <x>143</x>
     <y>30</y>
     <width>125</width>

tests/samples/outputs/motorSim.ioc.subst

@@ -24,7 +24,7 @@ pattern
 	{ "IBEK-MO-TST-01:", "3",      "asynMotor", "controllerOne", "2",    "CS Motor 2", "degrees", "0",   "10.0", "10.0", ".01",  "20000", "-20000", ""     }
 }
 
-file "simple.pvi.template" {
+file "Simple.pvi.template" {
 pattern 
 	{ "prefix"           }
 	{ "IBEK-MO-TST-01::" }

tests/samples/support/motorSim.ibek.support.yaml

@@ -51,7 +51,7 @@ defs:
           DESC:
 
     pvi:
-      yaml_path: simple.pvi.device.yaml
+      yaml_path: Simple.pvi.device.yaml
       prefix: "{{P}}:"
       pva_template: true
       index: true

tests/test_cli.py

@@ -113,8 +113,8 @@ def test_build_runtime_motorSim(tmp_path: Path, samples: Path):
     actual_index = (samples / "epics" / "opi" / "index.bob").read_text()
     assert example_index == actual_index
 
-    example_pvi = (samples / "outputs" / "simple.pvi.bob").read_text()
-    actual_pvi = (samples / "epics" / "opi" / "simple.pvi.bob").read_text()
+    example_pvi = (samples / "outputs" / "Simple.pvi.bob").read_text()
+    actual_pvi = (samples / "epics" / "opi" / "Simple.pvi.bob").read_text()
     assert example_pvi == actual_pvi