Adding new arg --cache-only to autobuild install command.

Useful for preparing an environment for future offline use where
packages can't be fetched.

Author: brad-linden

autobuild/autobuild_tool_install.py

@@ -301,7 +301,7 @@ def get_package_file(package_name, package_url, hash_algorithm='md5', expected_h
     return cache_file
 
 
-def do_install(packages, config_file, installed, platform, install_dir, dry_run, local_archives=[]):
+def do_install(packages, config_file, installed, platform, install_dir, dry_run, local_archives=[], cache_only=False):
     """
     Install the specified list of packages. By default this will download the
     packages to the local cache, extract the contents of those
@@ -322,10 +322,12 @@ def do_install(packages, config_file, installed, platform, install_dir, dry_run,
 
         # Existing tarball install, or new package install of either kind
         if pname in local_archives:
-            if _install_local(pname, platform, package, local_archives[pname], install_dir, installed, dry_run):
-                installed_pkgs.append(pname)
+            if not cache_only:
+                # local packages don't need to be placed in the cache
+                if _install_local(pname, platform, package, local_archives[pname], install_dir, installed, dry_run):
+                    installed_pkgs.append(pname)
         else:
-            if _install_binary(pname, platform, package, config_file, install_dir, installed, dry_run):
+            if _install_binary(pname, platform, package, config_file, install_dir, installed, dry_run, cache_only=cache_only):
                 installed_pkgs.append(pname)
     return installed_pkgs
 
@@ -354,7 +356,7 @@ def _install_local(configured_name, platform, package, package_path, install_dir
     else:
         return False
 
-def _install_binary(configured_name, platform, package, config_file, install_dir, installed, dry_run):
+def _install_binary(configured_name, platform, package, config_file, install_dir, installed, dry_run, cache_only=False):
     # Check that we have a platform-specific or common url to use.
     req_plat = package.get_platform(platform)
     package_name = getattr(package, 'name', '(undefined)')
@@ -387,6 +389,9 @@ def _install_binary(configured_name, platform, package, config_file, install_dir
     if cachefile is None:
         raise InstallError("Failed to download package '%s' from '%s'" % (package_name, archive.url))
 
+    if cache_only:
+        return True
+
     metadata, files = _install_common(configured_name, platform, package, cachefile, install_dir, installed, dry_run)
     if metadata:
         installed_package = package.copy()
@@ -761,9 +766,9 @@ def install_packages(args, config_file, install_dir, platform, packages):
 
     # do the actual install of any new/updated packages
     packages = do_install(packages, config_file, installed, platform, install_dir,
-                          args.dry_run, local_archives=local_archives)
+                          args.dry_run, local_archives=local_archives, cache_only=args.cache_only)
 
-    if not args.dry_run:
+    if not args.dry_run and not args.cache_only:
         # update the installed-packages.xml file
         try:
             # in case we got this far without ever having created installed_file's
@@ -886,6 +891,11 @@ def register(self, parser):
                             help="install packages for a specific build configuration\n(may be specified as comma separated values in $AUTOBUILD_CONFIGURATION)",
                             metavar='CONFIGURATION',
                             default=self.configurations_from_environment())
+        parser.add_argument('--cache-only',
+                            action='store_true',
+                            default=False,
+                            dest='cache_only',
+                            help="fetch remote pacakges and populate the cache but do not install.\nintended for use preparing environment for offline operation")
 
     def run(self, args):
         platform=common.get_current_platform()

tests/test_install.py

@@ -156,6 +156,7 @@ def __init__(self,
                      addrsize=32,
                      package=[],
                      skip_source_environment=False,
+                     cache_only=False,
                      ):
             # Take all constructor params and assign as object attributes.
             params = locals().copy()
@@ -782,3 +783,48 @@ def test_download_github_without_creds(self, mock_urlopen: MagicMock):
         with envvar("AUTOBUILD_GITHUB_TOKEN", None):
             with self.assertRaises(CredentialsNotFoundError):
                 autobuild_tool_install.download_package("https://example.org/foo.tar.bz2", creds="github")
+
+# -------------------------------------  -------------------------------------
+class TestInstallCacheOnly(BaseTest):
+    def setup_method(self, module):
+        super(TestInstallCacheOnly, self).setup_method(module)
+
+        self.pkg = "bogus"
+        # Set up options with cache_only flag
+        self.options.package = [self.pkg]
+        self.options.cache_only = True
+
+        # Ensure the package is not in the cache initially
+        cache_file = os.path.join(common.get_install_cache_dir(), "bogus-0.1-common-111.tar.bz2")
+        clean_file(cache_file)
+        assert not os.path.exists(cache_file)
+
+    def test_cache_only_success(self):
+        # Run install with --cache-only flag
+        autobuild_tool_install.AutobuildTool().run(self.options)
+
+        # Verify package was downloaded to cache
+        cache_file = os.path.join(common.get_install_cache_dir(), "bogus-0.1-common-111.tar.bz2")
+        assert os.path.exists(cache_file)
+
+        # Verify package was NOT installed to install directory
+        assert not os.path.exists(os.path.join(INSTALL_DIR, "lib", "bogus.lib"))
+        assert not os.path.exists(os.path.join(INSTALL_DIR, "include", "bogus.h"))
+
+        # Verify package is not listed in installed manifest
+        assert_not_in(self.pkg, query_manifest(self.options))
+
+    def test_cache_only_with_local_archives(self):
+        # Set up options with cache_only flag and local archives
+        cache_opts = self.options.copy()
+        cache_opts.local_archives = [os.path.join(mydir, "data", "bogus-0.1-common-111.tar.bz2")]
+
+        # Run install with --cache-only flag
+        autobuild_tool_install.AutobuildTool().run(cache_opts)
+
+        # Verify nothing was installed
+        assert not os.path.exists(os.path.join(INSTALL_DIR, "lib", "bogus.lib"))
+        assert not os.path.exists(os.path.join(INSTALL_DIR, "include", "bogus.h"))
+
+        # Verify package is not listed in installed manifest
+        assert_not_in(self.pkg, query_manifest(self.options))