|
| 1 | +"""Tests for --starred-skip-size-over flag behavior (issue #108).""" |
| 2 | + |
| 3 | +import pytest |
| 4 | +from unittest.mock import Mock |
| 5 | + |
| 6 | +from github_backup import github_backup |
| 7 | + |
| 8 | + |
| 9 | +class TestStarredSkipSizeOver: |
| 10 | + """Test suite for --starred-skip-size-over flag. |
| 11 | +
|
| 12 | + Issue #108: Allow restricting size of starred repositories before cloning. |
| 13 | + The size is based on the GitHub API's 'size' field (in KB), but the CLI |
| 14 | + argument accepts MB for user convenience. |
| 15 | + """ |
| 16 | + |
| 17 | + def _create_mock_args(self, **overrides): |
| 18 | + """Create a mock args object with sensible defaults.""" |
| 19 | + args = Mock() |
| 20 | + args.user = "testuser" |
| 21 | + args.repository = None |
| 22 | + args.name_regex = None |
| 23 | + args.languages = None |
| 24 | + args.fork = False |
| 25 | + args.private = False |
| 26 | + args.skip_archived = False |
| 27 | + args.starred_skip_size_over = None |
| 28 | + args.exclude = None |
| 29 | + |
| 30 | + for key, value in overrides.items(): |
| 31 | + setattr(args, key, value) |
| 32 | + |
| 33 | + return args |
| 34 | + |
| 35 | + |
| 36 | +class TestStarredSkipSizeOverArgumentParsing(TestStarredSkipSizeOver): |
| 37 | + """Tests for --starred-skip-size-over argument parsing.""" |
| 38 | + |
| 39 | + def test_starred_skip_size_over_not_set_defaults_to_none(self): |
| 40 | + """When --starred-skip-size-over is not specified, it should default to None.""" |
| 41 | + args = github_backup.parse_args(["testuser"]) |
| 42 | + assert args.starred_skip_size_over is None |
| 43 | + |
| 44 | + def test_starred_skip_size_over_accepts_integer(self): |
| 45 | + """--starred-skip-size-over should accept an integer value.""" |
| 46 | + args = github_backup.parse_args(["testuser", "--starred-skip-size-over", "500"]) |
| 47 | + assert args.starred_skip_size_over == 500 |
| 48 | + |
| 49 | + def test_starred_skip_size_over_rejects_non_integer(self): |
| 50 | + """--starred-skip-size-over should reject non-integer values.""" |
| 51 | + with pytest.raises(SystemExit): |
| 52 | + github_backup.parse_args(["testuser", "--starred-skip-size-over", "abc"]) |
| 53 | + |
| 54 | + |
| 55 | +class TestStarredSkipSizeOverFiltering(TestStarredSkipSizeOver): |
| 56 | + """Tests for --starred-skip-size-over filtering behavior.""" |
| 57 | + |
| 58 | + def test_starred_repo_under_limit_is_kept(self): |
| 59 | + """Starred repos under the size limit should be kept.""" |
| 60 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 61 | + |
| 62 | + repos = [ |
| 63 | + { |
| 64 | + "name": "small-repo", |
| 65 | + "owner": {"login": "otheruser"}, |
| 66 | + "size": 100 * 1024, # 100 MB in KB |
| 67 | + "is_starred": True, |
| 68 | + } |
| 69 | + ] |
| 70 | + |
| 71 | + result = github_backup.filter_repositories(args, repos) |
| 72 | + assert len(result) == 1 |
| 73 | + assert result[0]["name"] == "small-repo" |
| 74 | + |
| 75 | + def test_starred_repo_over_limit_is_filtered(self): |
| 76 | + """Starred repos over the size limit should be filtered out.""" |
| 77 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 78 | + |
| 79 | + repos = [ |
| 80 | + { |
| 81 | + "name": "huge-repo", |
| 82 | + "owner": {"login": "otheruser"}, |
| 83 | + "size": 600 * 1024, # 600 MB in KB |
| 84 | + "is_starred": True, |
| 85 | + } |
| 86 | + ] |
| 87 | + |
| 88 | + result = github_backup.filter_repositories(args, repos) |
| 89 | + assert len(result) == 0 |
| 90 | + |
| 91 | + def test_own_repo_over_limit_is_kept(self): |
| 92 | + """User's own repos should not be affected by the size limit.""" |
| 93 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 94 | + |
| 95 | + repos = [ |
| 96 | + { |
| 97 | + "name": "my-huge-repo", |
| 98 | + "owner": {"login": "testuser"}, |
| 99 | + "size": 600 * 1024, # 600 MB in KB |
| 100 | + # No is_starred flag - this is the user's own repo |
| 101 | + } |
| 102 | + ] |
| 103 | + |
| 104 | + result = github_backup.filter_repositories(args, repos) |
| 105 | + assert len(result) == 1 |
| 106 | + assert result[0]["name"] == "my-huge-repo" |
| 107 | + |
| 108 | + def test_starred_repo_at_exact_limit_is_kept(self): |
| 109 | + """Starred repos at exactly the size limit should be kept.""" |
| 110 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 111 | + |
| 112 | + repos = [ |
| 113 | + { |
| 114 | + "name": "exact-limit-repo", |
| 115 | + "owner": {"login": "otheruser"}, |
| 116 | + "size": 500 * 1024, # Exactly 500 MB in KB |
| 117 | + "is_starred": True, |
| 118 | + } |
| 119 | + ] |
| 120 | + |
| 121 | + result = github_backup.filter_repositories(args, repos) |
| 122 | + assert len(result) == 1 |
| 123 | + assert result[0]["name"] == "exact-limit-repo" |
| 124 | + |
| 125 | + def test_mixed_repos_filtered_correctly(self): |
| 126 | + """Mix of own and starred repos should be filtered correctly.""" |
| 127 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 128 | + |
| 129 | + repos = [ |
| 130 | + { |
| 131 | + "name": "my-huge-repo", |
| 132 | + "owner": {"login": "testuser"}, |
| 133 | + "size": 1000 * 1024, # 1 GB - own repo, should be kept |
| 134 | + }, |
| 135 | + { |
| 136 | + "name": "starred-small", |
| 137 | + "owner": {"login": "otheruser"}, |
| 138 | + "size": 100 * 1024, # 100 MB - under limit |
| 139 | + "is_starred": True, |
| 140 | + }, |
| 141 | + { |
| 142 | + "name": "starred-huge", |
| 143 | + "owner": {"login": "anotheruser"}, |
| 144 | + "size": 2000 * 1024, # 2 GB - over limit |
| 145 | + "is_starred": True, |
| 146 | + }, |
| 147 | + ] |
| 148 | + |
| 149 | + result = github_backup.filter_repositories(args, repos) |
| 150 | + assert len(result) == 2 |
| 151 | + names = [r["name"] for r in result] |
| 152 | + assert "my-huge-repo" in names |
| 153 | + assert "starred-small" in names |
| 154 | + assert "starred-huge" not in names |
| 155 | + |
| 156 | + def test_no_size_limit_keeps_all_starred(self): |
| 157 | + """When no size limit is set, all starred repos should be kept.""" |
| 158 | + args = self._create_mock_args(starred_skip_size_over=None) |
| 159 | + |
| 160 | + repos = [ |
| 161 | + { |
| 162 | + "name": "huge-starred-repo", |
| 163 | + "owner": {"login": "otheruser"}, |
| 164 | + "size": 10000 * 1024, # 10 GB |
| 165 | + "is_starred": True, |
| 166 | + } |
| 167 | + ] |
| 168 | + |
| 169 | + result = github_backup.filter_repositories(args, repos) |
| 170 | + assert len(result) == 1 |
| 171 | + |
| 172 | + def test_repo_without_size_field_is_kept(self): |
| 173 | + """Repos without a size field should be kept (size defaults to 0).""" |
| 174 | + args = self._create_mock_args(starred_skip_size_over=500) |
| 175 | + |
| 176 | + repos = [ |
| 177 | + { |
| 178 | + "name": "no-size-repo", |
| 179 | + "owner": {"login": "otheruser"}, |
| 180 | + "is_starred": True, |
| 181 | + # No size field |
| 182 | + } |
| 183 | + ] |
| 184 | + |
| 185 | + result = github_backup.filter_repositories(args, repos) |
| 186 | + assert len(result) == 1 |
| 187 | + |
| 188 | + def test_zero_value_warns_and_is_ignored(self, caplog): |
| 189 | + """Zero value should warn and keep all repos.""" |
| 190 | + args = self._create_mock_args(starred_skip_size_over=0) |
| 191 | + |
| 192 | + repos = [ |
| 193 | + { |
| 194 | + "name": "huge-starred-repo", |
| 195 | + "owner": {"login": "otheruser"}, |
| 196 | + "size": 10000 * 1024, # 10 GB |
| 197 | + "is_starred": True, |
| 198 | + } |
| 199 | + ] |
| 200 | + |
| 201 | + result = github_backup.filter_repositories(args, repos) |
| 202 | + assert len(result) == 1 |
| 203 | + assert "must be greater than 0" in caplog.text |
| 204 | + |
| 205 | + def test_negative_value_warns_and_is_ignored(self, caplog): |
| 206 | + """Negative value should warn and keep all repos.""" |
| 207 | + args = self._create_mock_args(starred_skip_size_over=-5) |
| 208 | + |
| 209 | + repos = [ |
| 210 | + { |
| 211 | + "name": "huge-starred-repo", |
| 212 | + "owner": {"login": "otheruser"}, |
| 213 | + "size": 10000 * 1024, # 10 GB |
| 214 | + "is_starred": True, |
| 215 | + } |
| 216 | + ] |
| 217 | + |
| 218 | + result = github_backup.filter_repositories(args, repos) |
| 219 | + assert len(result) == 1 |
| 220 | + assert "must be greater than 0" in caplog.text |
| 221 | + |
| 222 | + |
| 223 | +if __name__ == "__main__": |
| 224 | + pytest.main([__file__, "-v"]) |
0 commit comments