try validating earlier

Author: ScottCarda-MS

.ado/publish.yml

@@ -93,6 +93,13 @@ extends:
                   versionSpec: "3.11"
                 displayName: Set Python version
 
+              - script: |
+                  python set_version.py --validate-only
+                env:
+                  BUILD_TYPE: ${{ parameters.Build_Type }}
+                  VERSION: ${{ parameters.Version }}
+                displayName: Validate version input
+
               - task: PipAuthenticate@1
                 displayName: Authenticate pip to Azure Artifacts feed
                 inputs:

set_version.py

@@ -207,6 +207,53 @@ def get_build_version(version_type: str, build_type: str) -> str:
     return build_version
 
 
+def validate_specified_version(build_type: str, version: str) -> str:
+    """Validate a manually specified version and return it stripped.
+
+    Returns "" when no version is specified (blank/whitespace), signalling that the
+    version should be computed automatically. Raises ``ValueError`` when a version is
+    specified but is malformed or disagrees with ``build_type``.
+
+    This performs only local checks (no network), so it is safe to run as an early
+    fail-fast step before any package-index access.
+
+    :param build_type: Build type ("stable"/"dev"/"rc"). Determines which pre-release
+        suffix a specified version must carry.
+    :param version: Candidate version string, or "" to compute automatically.
+    :return: The stripped version, or "" if none was specified.
+    :rtype: str
+    """
+    specified_version = (version or "").strip()
+    if not specified_version:
+        return ""
+
+    if not VERSION_INPUT_RE.match(specified_version):
+        raise ValueError(
+            f"Version \"{specified_version}\" is not a valid version. Expected "
+            f"\"major.minor.patch\" optionally followed by \".devN\" or \".rcN\"."
+        )
+
+    # The specified version must match the selected build type, so a build tagged
+    # "dev"/"rc" can't ship a version that lacks (or mismatches) the suffix.
+    if build_type == "dev" and ".dev" not in specified_version:
+        raise ValueError(
+            f"Build type \"dev\" requires a \".devN\" version, but got "
+            f"\"{specified_version}\"."
+        )
+    if build_type == "rc" and ".rc" not in specified_version:
+        raise ValueError(
+            f"Build type \"rc\" requires a \".rcN\" version, but got "
+            f"\"{specified_version}\"."
+        )
+    if build_type == "stable" and (".dev" in specified_version or ".rc" in specified_version):
+        raise ValueError(
+            f"Build type \"stable\" requires a \"major.minor.patch\" version "
+            f"without a pre-release suffix, but got \"{specified_version}\"."
+        )
+
+    return specified_version
+
+
 def resolve_build_version(version_type: str, build_type: str, version: str = "") -> str:
     """Resolve the version to ship for this run.
 
@@ -226,39 +273,24 @@ def resolve_build_version(version_type: str, build_type: str, version: str = "")
     :return: The version to ship.
     :rtype: str
     """
-    specified_version = (version or "").strip()
+    specified_version = validate_specified_version(build_type, version)
     if specified_version:
-        if not VERSION_INPUT_RE.match(specified_version):
-            raise ValueError(
-                f"Version \"{specified_version}\" is not a valid version. Expected "
-                f"\"major.minor.patch\" optionally followed by \".devN\" or \".rcN\"."
-            )
-
-        # The specified version must match the selected build type, so a build tagged
-        # "dev"/"rc" can't ship a version that lacks (or mismatches) the suffix.
-        if build_type == "dev" and ".dev" not in specified_version:
-            raise ValueError(
-                f"Build type \"dev\" requires a \".devN\" version, but got "
-                f"\"{specified_version}\"."
-            )
-        if build_type == "rc" and ".rc" not in specified_version:
-            raise ValueError(
-                f"Build type \"rc\" requires a \".rcN\" version, but got "
-                f"\"{specified_version}\"."
-            )
-        if build_type == "stable" and (".dev" in specified_version or ".rc" in specified_version):
-            raise ValueError(
-                f"Build type \"stable\" requires a \"major.minor.patch\" version "
-                f"without a pre-release suffix, but got \"{specified_version}\"."
-            )
-
         print(f"Using manually specified version: {specified_version}")
         return specified_version
 
     return get_build_version(version_type, build_type)
 
 
 if __name__ == "__main__":
+    import sys
+
+    # Early fail-fast mode: validate the manually specified version (if any) without
+    # touching the network, so a bad input stops the run before expensive setup.
+    if "--validate-only" in sys.argv:
+        validate_specified_version(BUILD_TYPE, VERSION)
+        print("Version input is valid.")
+        sys.exit(0)
+
     build_version = resolve_build_version(RELEASE_TYPE, BUILD_TYPE, VERSION)
 
     print(f"Package version: {build_version}")

test_set_version.py

@@ -9,6 +9,7 @@
     _version_sort_key,
     get_build_version,
     resolve_build_version,
+    validate_specified_version,
     VERSION_RE,
 )
 
@@ -214,4 +215,41 @@ def test_resolve_build_version_accepts_matching_build_type(monkeypatch, build_ty
     monkeypatch.setattr(
         set_version, "get_build_version", lambda *a, **k: "should-not-be-used"
     )
-    assert resolve_build_version("patch", build_type, version) == version
+    assert resolve_build_version("patch", build_type, version) == version
+
+
+@pytest.mark.parametrize("blank", ["", "   ", None])
+def test_validate_specified_version_blank_returns_empty(blank):
+    # A blank/whitespace/None version returns "" (signalling automatic computation)
+    # and never touches the network.
+    assert validate_specified_version("dev", blank) == ""
+
+
+@pytest.mark.parametrize(
+    "build_type,version",
+    [
+        ("dev", "1.2.3.dev0"),
+        ("rc", "1.2.3.rc7"),
+        ("stable", "1.2.3"),
+        ("dev", "  1.2.3.dev0  "),
+    ],
+)
+def test_validate_specified_version_returns_stripped(build_type, version):
+    # A valid version is returned stripped of surrounding whitespace.
+    assert validate_specified_version(build_type, version) == version.strip()
+
+
+@pytest.mark.parametrize(
+    "build_type,version",
+    [
+        ("dev", "1.2"),
+        ("dev", "v1.2.3"),
+        ("dev", "1.2.3"),
+        ("rc", "1.2.3.dev0"),
+        ("stable", "1.2.3.rc0"),
+    ],
+)
+def test_validate_specified_version_rejects_invalid(build_type, version):
+    # Malformed or build-type-mismatched versions fail loud.
+    with pytest.raises(ValueError):
+        validate_specified_version(build_type, version)