feat: add ability to skip check section for a specific component (#437)

* feat: add ability to skip check section for a specific component

* Update docs/reference/overlays.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: remove commas from jsonschema descriptions and use single % for %check (#438)

* Initial plan

* fix: remove commas from jsonschema descriptions and use single % for %check

Co-authored-by: tobiasb_microsoft <115835401+tobiasb_microsoft@users.noreply.github.com>

* test: update snapshots for schema changes

Co-authored-by: tobiasb_microsoft <115835401+tobiasb_microsoft@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tobiasb_microsoft <115835401+tobiasb_microsoft@users.noreply.github.com>

* chore: rename reason to skip_reason for clarity and future-proofing

* fix: change wording and use skip_reason in overlays.md

* chore: move check config documentation into a new file because it is not an overlay

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tobiasb_microsoft <115835401+tobiasb_microsoft@users.noreply.github.com>

Author: 4 people

docs/reference/customized-build-options.md

@@ -0,0 +1,21 @@
+# Customized Build Options
+There are options to customize an overall component build.
+
+## Customized Build Types
+
+### Check Section
+To disable the `%check` section of a spec when there are known test issues, use the `check` build configuration option:
+
+```toml
+[components.mypackage.build]
+check = {skip = true, skip_reason = "Tests require network access unavailable in build environment"}
+```
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `skip` | boolean | No | When `true`, disables the `%check` section (defaults to `false` when omitted) |
+| `skip_reason` | string | Conditional (when skip=true) | Justification for why the check section is being skipped |
+
+When `skip` is `true`, azldev prevents the code in the `%check` section from running.
+
+> **Note:** The `skip_reason` field is required when `skip` is `true`. This ensures that disabling tests is always documented and traceable.

internal/app/azldev/core/sources/sourceprep.go

@@ -224,6 +224,15 @@ func (p *sourcePreparerImpl) postProcessSources(
 		}
 	}
 
+	// Apply check skip overlay if configured.
+	checkSkipOverlays := synthesizeCheckSkipOverlays(component.GetConfig().Build.Check)
+	for _, overlay := range checkSkipOverlays {
+		err = ApplyOverlayToSources(p.dryRunnable, p.fs, overlay, sourcesDirPath, absSpecPath)
+		if err != nil {
+			return fmt.Errorf("failed to apply check skip overlay to sources for component %#q:\n%w", component.GetName(), err)
+		}
+	}
+
 	// Finally, apply the file header overlay.
 	for _, overlay := range headerOverlay {
 		err = ApplyOverlayToSources(p.dryRunnable, p.fs, overlay, sourcesDirPath, absSpecPath)
@@ -288,6 +297,27 @@ func generateFileHeaderOverlay() []projectconfig.ComponentOverlay {
 	}
 }
 
+// synthesizeCheckSkipOverlays generates overlays to disable the %check section if configured.
+// When check.skip is true, it prepends an 'exit 0' to the %check section with a comment
+// explaining why the section was disabled.
+func synthesizeCheckSkipOverlays(checkConfig projectconfig.CheckConfig) []projectconfig.ComponentOverlay {
+	if !checkConfig.Skip {
+		return nil
+	}
+
+	return []projectconfig.ComponentOverlay{
+		{
+			Type:        projectconfig.ComponentOverlayPrependSpecLines,
+			SectionName: "%check",
+			Lines: []string{
+				"# Check section disabled: " + checkConfig.SkipReason,
+				"exit 0",
+				"",
+			},
+		},
+	}
+}
+
 func findSpecInDir(
 	fs opctx.FS, component components.Component, dirPath string,
 ) (string, error) {

internal/app/azldev/core/sources/sourceprep_test.go

@@ -275,3 +275,107 @@ func TestGenerateMacrosFileContents_FullConfig(t *testing.T) {
 	// Verify file ends with newline.
 	assert.Equal(t, '\n', rune(contents[len(contents)-1]))
 }
+
+func TestPrepareSources_CheckSkip(t *testing.T) {
+	const outputSpecPath = testOutputDir + "/test-component.spec"
+
+	ctrl := gomock.NewController(t)
+	component := components_testutils.NewMockComponent(ctrl)
+	sourceManager := sourceproviders_test.NewMockSourceManager(ctrl)
+	ctx := testctx.NewCtx()
+
+	component.EXPECT().GetName().AnyTimes().Return("test-component")
+	component.EXPECT().GetConfig().AnyTimes().Return(&projectconfig.ComponentConfig{
+		Build: projectconfig.ComponentBuildConfig{
+			Check: projectconfig.CheckConfig{
+				Skip:       true,
+				SkipReason: "Tests require network access",
+			},
+		},
+	})
+	sourceManager.EXPECT().FetchComponent(gomock.Any(), component, testOutputDir).DoAndReturn(
+		func(_ interface{}, _ interface{}, outputDir string) error {
+			// Create the expected spec file with a %check section.
+			specContent := `Name: test-component
+Version: 1.0
+Release: 1
+Summary: Test component
+
+%check
+make test
+`
+
+			return fileutils.WriteFile(ctx.FS(), outputSpecPath, []byte(specContent), 0o644)
+		},
+	)
+
+	preparer, err := sources.NewPreparer(sourceManager, ctx.FS(), ctx, ctx)
+	require.NoError(t, err)
+	err = preparer.PrepareSources(ctx, component, testOutputDir, true /*applyOverlays?*/)
+	require.NoError(t, err)
+
+	// Verify spec has check skip prepended.
+	specContents, err := fileutils.ReadFile(ctx.FS(), outputSpecPath)
+	require.NoError(t, err)
+
+	specStr := string(specContents)
+
+	assert.Contains(t, specStr, "# Check section disabled: Tests require network access")
+	assert.Contains(t, specStr, "exit 0")
+
+	// Verify exit 0 appears after %check and before original content.
+	checkIdx := strings.Index(specStr, "%check")
+	exitIdx := strings.Index(specStr, "exit 0")
+	makeTestIdx := strings.Index(specStr, "make test")
+
+	assert.Greater(t, checkIdx, -1, "%check should be present")
+	assert.Greater(t, exitIdx, checkIdx, "exit 0 should come after %check")
+	assert.Greater(t, makeTestIdx, exitIdx, "make test should come after exit 0")
+}
+
+func TestPrepareSources_CheckSkipDisabled(t *testing.T) {
+	const outputSpecPath = testOutputDir + "/test-component.spec"
+
+	ctrl := gomock.NewController(t)
+	component := components_testutils.NewMockComponent(ctrl)
+	sourceManager := sourceproviders_test.NewMockSourceManager(ctrl)
+	ctx := testctx.NewCtx()
+
+	component.EXPECT().GetName().AnyTimes().Return("test-component")
+	component.EXPECT().GetConfig().AnyTimes().Return(&projectconfig.ComponentConfig{
+		Build: projectconfig.ComponentBuildConfig{
+			Check: projectconfig.CheckConfig{
+				Skip: false,
+			},
+		},
+	})
+	sourceManager.EXPECT().FetchComponent(gomock.Any(), component, testOutputDir).DoAndReturn(
+		func(_ interface{}, _ interface{}, outputDir string) error {
+			// Create the expected spec file with a %check section.
+			specContent := `Name: test-component
+Version: 1.0
+Release: 1
+Summary: Test component
+
+%check
+make test
+`
+
+			return fileutils.WriteFile(ctx.FS(), outputSpecPath, []byte(specContent), 0o644)
+		},
+	)
+
+	preparer, err := sources.NewPreparer(sourceManager, ctx.FS(), ctx, ctx)
+	require.NoError(t, err)
+	err = preparer.PrepareSources(ctx, component, testOutputDir, true /*applyOverlays?*/)
+	require.NoError(t, err)
+
+	// Verify spec does NOT have check skip prepended.
+	specContents, err := fileutils.ReadFile(ctx.FS(), outputSpecPath)
+	require.NoError(t, err)
+
+	specStr := string(specContents)
+
+	assert.NotContains(t, specStr, "# Check section disabled")
+	assert.NotContains(t, specStr, "exit 0")
+}

internal/projectconfig/build.go

@@ -3,6 +3,32 @@
 
 package projectconfig
 
+import (
+	"errors"
+	"fmt"
+)
+
+// CheckConfig encapsulates configuration for the %check section of a spec file.
+type CheckConfig struct {
+	// Skip indicates whether the %check section should be disabled for this component.
+	Skip bool `toml:"skip,omitempty" json:"skip,omitempty" jsonschema:"title=Skip check,description=Disables the %check section by prepending 'exit 0' when set to true"`
+	// SkipReason provides a required justification when Skip is true.
+	SkipReason string `toml:"skip_reason,omitempty" json:"skipReason,omitempty" jsonschema:"title=Skip reason,description=Required justification for skipping the %check section"`
+}
+
+// Validate checks that required fields are set when Skip is true.
+func (c *CheckConfig) Validate() error {
+	if !c.Skip {
+		return nil
+	}
+
+	if c.SkipReason == "" {
+		return errors.New("check.skip_reason is required when check.skip is true")
+	}
+
+	return nil
+}
+
 // Encapsulates configuration for building a component. Configuration for how to acquire
 // or prepare the sources for a component are out of scope.
 type ComponentBuildConfig struct {
@@ -12,4 +38,15 @@ type ComponentBuildConfig struct {
 	Without []string `toml:"without,omitempty" json:"without,omitempty" jsonschema:"title=Without options,description='without' options to pass to the builder."`
 	// Macro definitions.
 	Defines map[string]string `toml:"defines,omitempty" json:"defines,omitempty" jsonschema:"title=Macro definitions,description=Macro definitions to pass to the builder."`
+	// Check section configuration.
+	Check CheckConfig `toml:"check,omitempty" json:"check,omitempty" jsonschema:"title=Check configuration,description=Configuration for the %check section"`
+}
+
+// Validate checks that the build configuration is valid.
+func (c *ComponentBuildConfig) Validate() error {
+	if err := c.Check.Validate(); err != nil {
+		return fmt.Errorf("invalid build configuration:\n%w", err)
+	}
+
+	return nil
 }

internal/projectconfig/build_test.go

@@ -0,0 +1,131 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+package projectconfig_test
+
+import (
+	"testing"
+
+	"github.com/gim-home/azldev-preview/internal/projectconfig"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCheckConfig_Validate(t *testing.T) {
+	testCases := []struct {
+		name          string
+		config        projectconfig.CheckConfig
+		errorExpected bool
+		errorContains string
+	}{
+		{
+			name:          "empty config is valid",
+			config:        projectconfig.CheckConfig{},
+			errorExpected: false,
+		},
+		{
+			name: "skip false without reason is valid",
+			config: projectconfig.CheckConfig{
+				Skip: false,
+			},
+			errorExpected: false,
+		},
+		{
+			name: "skip true with reason is valid",
+			config: projectconfig.CheckConfig{
+				Skip:       true,
+				SkipReason: "Tests require network access",
+			},
+			errorExpected: false,
+		},
+		{
+			name: "skip true without reason is invalid",
+			config: projectconfig.CheckConfig{
+				Skip: true,
+			},
+			errorExpected: true,
+			errorContains: "skip_reason",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			err := testCase.config.Validate()
+
+			if testCase.errorExpected {
+				require.Error(t, err)
+
+				if testCase.errorContains != "" {
+					assert.Contains(t, err.Error(), testCase.errorContains)
+				}
+
+				return
+			}
+
+			require.NoError(t, err)
+		})
+	}
+}
+
+func TestComponentBuildConfig_Validate(t *testing.T) {
+	testCases := []struct {
+		name          string
+		config        projectconfig.ComponentBuildConfig
+		errorExpected bool
+		errorContains string
+	}{
+		{
+			name:          "empty config is valid",
+			config:        projectconfig.ComponentBuildConfig{},
+			errorExpected: false,
+		},
+		{
+			name: "config with with/without/defines is valid",
+			config: projectconfig.ComponentBuildConfig{
+				With:    []string{"feature1"},
+				Without: []string{"feature2"},
+				Defines: map[string]string{"key": "value"},
+			},
+			errorExpected: false,
+		},
+		{
+			name: "config with valid check skip is valid",
+			config: projectconfig.ComponentBuildConfig{
+				Check: projectconfig.CheckConfig{
+					Skip:       true,
+					SkipReason: "Tests require network access",
+				},
+			},
+			errorExpected: false,
+		},
+		{
+			name: "config with invalid check skip propagates error",
+			config: projectconfig.ComponentBuildConfig{
+				Check: projectconfig.CheckConfig{
+					Skip: true,
+					// Missing SkipReason
+				},
+			},
+			errorExpected: true,
+			errorContains: "skip_reason",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			err := testCase.config.Validate()
+
+			if testCase.errorExpected {
+				require.Error(t, err)
+
+				if testCase.errorContains != "" {
+					assert.Contains(t, err.Error(), testCase.errorContains)
+				}
+
+				return
+			}
+
+			require.NoError(t, err)
+		})
+	}
+}

internal/projectconfig/configfile.go

@@ -62,6 +62,12 @@ func (f ConfigFile) Validate() error {
 				return fmt.Errorf("invalid overlay %d for component %#q:\n%w", i+1, componentName, err)
 			}
 		}
+
+		// Validate build configuration.
+		err := component.Build.Validate()
+		if err != nil {
+			return fmt.Errorf("invalid build config for component %#q:\n%w", componentName, err)
+		}
 	}
 
 	return nil