Merge pull request #305 from jacebrowning/all-keyword

Use the 'all' keyword to override the default group

Author: jacebrowning

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Updated messaging to clarify when nested dependencies are updated.
 - Added a warning when no dependencies match the specified names.
+- Added `all` as a keyword to bypass the default dependency group.
 
 # 3.3.3 (2023-01-25)
 

docs/use-cases/default-groups.md

@@ -5,7 +5,17 @@ dependencies to install if no inputs are provided to `gitman install`. If
 if is set to a blank string, `default_group: ''`, then all sources are
 installed.
 
-When nested gitman projects are used default groups are installed if they
+## Overriding Groups
+
+To ignore the `default_group` and install all dependencies, use the `all` keyword:
+
+```sh
+$ gitman install all
+```
+
+## Nested Projects
+
+When nested Gitman projects are used default groups are installed if they
 exist. In the case of the following project layout:
 
 Project A's configuration file:

gitman/models/config.py

@@ -364,7 +364,6 @@ def _get_sources_filter(
     ) -> List[str]:
         """Get a filtered subset of sources."""
         names_list = list(names)
-
         if not names_list and not skip_default_group:
             names_list.append(self.default_group)
 
@@ -377,8 +376,9 @@ def _get_sources_filter(
             [source.name for source in sources if source.name in names_list]
         )
 
+        # Fall back to all sources if allowed
         if not sources_filter:
-            if names:
+            if names and names_list != ["all"]:
                 log.warn(f"No dependencies match: {' '.join(names)}")
             else:
                 sources_filter = [source.name for source in sources if source.name]

gitman/tests/test_models_config.py

@@ -72,13 +72,23 @@ def test_install_with_names(self):
         count = config.install_dependencies("gitman_2", "gitman_3")
         assert 2 == count
 
+    @pytest.mark.integration
+    def test_install_with_names_all(self):
+        """Verify all dependencies can be installed."""
+        config = Config(FILES)
+
+        count = config.install_dependencies("all")
+        assert 7 == count
+
+    @pytest.mark.integration
     def test_install_with_names_unknown(self):
         """Verify zero dependencies are installed with unknown dependency."""
         config = Config(FILES)
 
         count = config.install_dependencies("foobar")
         assert 0 == count
 
+    @pytest.mark.integration
     def test_install_with_depth_0(self):
         """Verify an install depth of 0 installs nothing."""
         config = Config(FILES)

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "gitman"
-version = "3.4b2"
+version = "3.4b3"
 description = "A language-agnostic dependency manager using Git."
 
 license = "MIT"

tests/test_api.py

@@ -257,6 +257,10 @@ def it_should_create_links(config_with_link):
 
             expect(os.listdir()).contains("my_link")
 
+        @pytest.mark.xfail(
+            os.name == "nt",
+            reason="https://github.com/jacebrowning/gitman/issues/284",
+        )
         def it_should_not_overwrite_files(config_with_link):
             os.system("touch my_link")
 
@@ -298,9 +302,6 @@ def config_with_links(config):
 
             return config
 
-        @pytest.mark.xfail(
-            os.name == "nt", reason="https://github.com/jacebrowning/gitman/issues/284"
-        )
         def it_should_create_links(config_with_links):
             expect(gitman.install(depth=1)) == True
             expect(os.listdir()).contains("gmd_3")
@@ -1167,9 +1168,6 @@ def git_changes(
         """
         )
 
-    @pytest.mark.xfail(
-        os.name == "nt", reason="https://github.com/jacebrowning/gitman/issues/284"
-    )
     def it_merges_sources(config):
         config.datafile.text = strip(
             """