Replace compile-time validateFormatting parameter

doc/eng_sys_checks.md

@@ -112,6 +112,8 @@ This is the most useful skip, but the following skip variables are also supporte
   - Omit checking that a package's dependencies are on PyPI before releasing.
 - `Skip.KeywordCheck`
   - Omit checking that a package's keywords are correctly formulated before releasing.
+- `Skip.Black`
+  - Omit checking `black` in the `analyze` job.
 
 ## The pyproject.toml
 
@@ -172,7 +174,7 @@ You can enable test logging in a pipeline by setting the queue time variable `PY
 
 `PYTEST_LOG_LEVEL=INFO`
 
-This also works locally with tox by setting the `PYTEST_LOG_LEVEL` environment variable. 
+This also works locally with tox by setting the `PYTEST_LOG_LEVEL` environment variable.
 
 Note that if you want DEBUG level logging with sensitive information unredacted in the test logs, then you still must pass `logging_enable=True` into the client(s) being used in tests.
 
@@ -237,17 +239,17 @@ fail if docstring are invalid, helping to ensure the resulting documentation wil
 
 #### Opt-in to formatting validation
 
-Make the following change to your projects `ci.yml`:
+Ensure that `black = true` is present within your `pyproject.toml`:
 
 ```yml
-extends:
-    template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml
-    parameters:
-        ...
-        ValidateFormatting: true
-        ...
+[tool.azure-sdk-build]
+...other checks enabled/disabled
+black = true
+...other checks enabled/disabled
 ```
 
+to opt into the black invocation.
+
 #### Running locally
 
 1. Go to package root directory.

eng/pipelines/templates/jobs/ci.yml

@@ -49,9 +49,6 @@ parameters:
   - name: VerifyAutorest
     type: boolean
     default: false
-  - name: ValidateFormatting
-    type: boolean
-    default: false
   - name: UnsupportedToxEnvironments
     type: string
     default: ''
@@ -229,7 +226,6 @@ jobs:
         TestPipeline: ${{ parameters.TestPipeline }}
         Artifacts: ${{ parameters.Artifacts }}
         VerifyAutorest: ${{ parameters.VerifyAutorest }}
-        ValidateFormatting: ${{ parameters.ValidateFormatting }}
         GenerateApiReviewForManualOnly: ${{ parameters.GenerateApiReviewForManualOnly }}
 
   - template: /eng/common/pipelines/templates/jobs/generate-job-matrix.yml

eng/pipelines/templates/stages/archetype-sdk-client.yml

@@ -63,9 +63,6 @@ parameters:
   - name: VerifyAutorest
     type: boolean
     default: false
-  - name: ValidateFormatting
-    type: boolean
-    default: false
   - name: TestProxy
     type: boolean
     default: true
@@ -107,7 +104,6 @@ extends:
               MatrixFilters: ${{ parameters.MatrixFilters }}
               MatrixReplace: ${{ parameters.MatrixReplace }}
               VerifyAutorest: ${{ parameters.VerifyAutorest }}
-              ValidateFormatting: ${{ parameters.ValidateFormatting }}
               TestProxy: ${{ parameters.TestProxy }}
               GenerateApiReviewForManualOnly: ${{ parameters.GenerateApiReviewForManualOnly }}
 

eng/pipelines/templates/steps/analyze.yml

@@ -5,7 +5,6 @@ parameters:
   Artifacts: []
   TestPipeline: false
   VerifyAutorest: false
-  ValidateFormatting: false
   GenerateApiReviewForManualOnly: false
 
 # Please use `$(TargetingString)` to refer to the python packages glob string. This variable is set from resolve-package-targeting.yml.
@@ -110,11 +109,9 @@ steps:
       ServiceDirectory: ${{ parameters.ServiceDirectory }}
       AdditionalTestArgs: ${{ parameters.AdditionalTestArgs }}
 
-  - ${{ if parameters.ValidateFormatting }}:
-    - template: run_black.yml
-      parameters:
-        ServiceDirectory: ${{ parameters.ServiceDirectory }}
-        ValidateFormatting: ${{ parameters.ValidateFormatting }}
+  - template: run_black.yml
+    parameters:
+      ServiceDirectory: ${{ parameters.ServiceDirectory }}
 
   - task: PythonScript@0
     displayName: 'Run Keyword Validation Check'

eng/pipelines/templates/steps/run_black.yml

@@ -1,6 +1,5 @@
 parameters:
   ServiceDirectory: ''
-  ValidateFormatting: false
   EnvVars: {}
   AdditionalTestArgs: ''
 
@@ -19,10 +18,13 @@ steps:
   - task: PythonScript@0
     displayName: 'Run Black'
     inputs:
-      scriptPath: 'scripts/devops_tasks/validate_formatting.py'
+      scriptPath: 'scripts/devops_tasks/dispatch_tox.py'
       arguments: >-
         "$(TargetingString)"
-        --service_directory="${{ parameters.ServiceDirectory }}"
-        --validate="${{ parameters.ValidateFormatting }}"
+        --mark_arg="${{ parameters.TestMarkArgument }}"
+        --service="${{ parameters.ServiceDirectory }}"
+        --toxenv="black"
+        --filter-type="Omit_management"
+        ${{ parameters.AdditionalTestArgs }}
     env: ${{ parameters.EnvVars }}
-    condition: and(succeededOrFailed(), ne(variables['Skip.Pylint'],'true'))
+    condition: and(succeededOrFailed(), ne(variables['Skip.Black'],'true'))

eng/tox/run_black.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# This script is used to execute pylint within a tox environment. Depending on which package is being executed against,
+# a failure may be suppressed.
+
+import subprocess
+import argparse
+import os
+import logging
+import sys
+
+from ci_tools.environment_exclusions import is_check_enabled
+from ci_tools.parsing import ParsedSetup
+from ci_tools.variables import in_ci
+
+logging.getLogger().setLevel(logging.INFO)
+
+root_dir = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", ".."))
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="Run black against target folder. Uses the black config in eng/black-pyproject.toml."
+    )
+
+    parser.add_argument(
+        "-t",
+        "--target",
+        dest="target_package",
+        help="The target package directory on disk.",
+        required=True,
+    )
+
+    args = parser.parse_args()
+
+    pkg_dir = os.path.abspath(args.target_package)
+    pkg_details = ParsedSetup.from_path(pkg_dir)
+    configFileLocation = os.path.join(root_dir, "eng/black-pyproject.toml")
+
+    if in_ci():
+        if not is_check_enabled(args.target_package, "black"):
+            logging.info(
+                f"Package {pkg_details.name} opts-out of black check."
+            )
+            exit(0)
+
+    try:
+        run_result = subprocess.run(
+            [
+                sys.executable,
+                "-m",
+                "black",
+                f"--config={configFileLocation}",
+                args.target_package,
+            ],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE
+        )
+
+        if run_result.stderr and "reformatted" in run_result.stderr.decode("utf-8"):
+            if in_ci():
+                logging.info(f"The package {pkg_details.name} needs reformat. Run the `black` tox env locally to reformat.")
+                exit(1)
+            else:
+                logging.info(f"The package {pkg_details.name} was reformatted.")
+
+    except subprocess.CalledProcessError as e:
+        logging.error(
+            f"Unable to invoke black for {pkg_details.name}. Ran into exception {e}."
+        )
+

eng/tox/tox.ini

@@ -531,9 +531,9 @@ description=Runs the code formatter black
 skip_install=true
 deps=
   black==24.4.0
+  -rdev_requirements.txt
 commands=
-  black --config {repository_root}/eng/black-pyproject.toml {posargs}
-
+  python {repository_root}/eng/tox/run_black.py -t {tox_root}
 
 [testenv:generate]
 description=Regenerate the code

sdk/appconfiguration/azure-appconfiguration-provider/pyproject.toml

@@ -1,2 +1,3 @@
 [tool.azure-sdk-build]
 pyright = false
+black = true

sdk/appconfiguration/azure-appconfiguration/pyproject.toml

@@ -1,2 +1,3 @@
 [tool.azure-sdk-build]
 pyright = false
+black = true

sdk/appconfiguration/ci.yml

@@ -31,7 +31,6 @@ extends:
     TestProxy: true
     ServiceDirectory: appconfiguration
     VerifyAutorest: false
-    ValidateFormatting: true
     Artifacts:
     - name: azure-appconfiguration
       safeName: azureappconfiguration

sdk/containerregistry/azure-containerregistry/pyproject.toml

@@ -1,2 +1,3 @@
 [tool.azure-sdk-build]
 pyright = false
+black = true

sdk/containerregistry/azure-mgmt-containerregistry/pyproject.toml

@@ -1,2 +1,3 @@
 [tool.azure-sdk-build]
 breaking = false
+black = true

sdk/containerregistry/ci.yml

@@ -30,7 +30,6 @@ extends:
   parameters:
     TestProxy: true
     ServiceDirectory: containerregistry
-    ValidateFormatting: true
     Artifacts:
     - name: azure-mgmt-containerregistry
       safeName: azuremgmtcontainerregistry

sdk/core/azure-core-experimental/pyproject.toml

@@ -2,3 +2,4 @@
 type_check_samples = false
 pyright = false
 mypy = true
+black = true

sdk/core/azure-core-tracing-opentelemetry/pyproject.toml

@@ -1,3 +1,4 @@
 [tool.azure-sdk-build]
 type_check_samples = false
 pyright = false
+black = true

sdk/core/azure-core/pyproject.toml

@@ -3,6 +3,7 @@ mypy = true
 type_check_samples = true
 verifytypes = true
 pyright = false
+black = true
 # For test environments or static checks where a check should be run by default, not explicitly disabling will enable the check.
 # pylint is enabled by default, so there is no reason for a pylint = true in every pyproject.toml.
 #

sdk/core/azure-mgmt-core/pyproject.toml

@@ -4,3 +4,4 @@ verifytypes = true
 pyright = false
 type_check_samples = false
 breaking = false
+black = true

sdk/core/ci.yml

@@ -36,7 +36,6 @@ extends:
   parameters:
     ServiceDirectory: core
     BuildTargetingString: "*"
-    ValidateFormatting: true
     TestProxy: false
     TestTimeoutInMinutes: 120
     Artifacts:

sdk/core/corehttp/pyproject.toml

@@ -1,3 +1,4 @@
 [tool.azure-sdk-build]
 pyright = false
 verify_keywords = false
+black = true