configurationOverride object

A configurationOverride object modifies the effective runtime configuration of a specified reportingDescriptor object, which we refer to as theDescriptor.

Graph sarif.json Simple API Fluent Builder API

Tip

Generated with following command : php ./resources/serialize.php configurationOverride docs/assets/sarif 192

docs/assets/sarif/configurationOverride.json

{
    "$schema": "https://json.schemastore.org/sarif-2.1.0.json",
    "version": "2.1.0",
    "runs": [
        {
            "tool": {
                "driver": {
                    "name": "CodeScanner",
                    "semanticVersion": "1.1.2-beta.12",
                    "informationUri": "https://codeScanner.dev",
                    "rules": [
                        {
                            "id": "CA2101",
                            "defaultConfiguration": {
                                "enabled": true,
                                "level": "error",
                                "rank": -1
                            }
                        }
                    ]
                }
            },
            "invocations": [
                {
                    "executionSuccessful": true,
                    "ruleConfigurationOverrides": [
                        {
                            "configuration": {
                                "enabled": true,
                                "level": "warning",
                                "rank": -1
                            },
                            "descriptor": {
                                "index": 0
                            }
                        }
                    ]
                }
            ],
            "results": []
        }
    ]
}

examples/configurationOverride.php

<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

use Bartlett\Sarif\Definition\ConfigurationOverride;
use Bartlett\Sarif\Definition\Invocation;
use Bartlett\Sarif\Definition\ReportingConfiguration;
use Bartlett\Sarif\Definition\ReportingDescriptor;
use Bartlett\Sarif\Definition\ReportingDescriptorReference;
use Bartlett\Sarif\Definition\Run;
use Bartlett\Sarif\Definition\Tool;
use Bartlett\Sarif\Definition\ToolComponent;
use Bartlett\Sarif\SarifLog;

require_once dirname(__DIR__) . '/vendor/autoload.php';

$driver = new ToolComponent();
$driver->setName('CodeScanner');
$driver->setInformationUri('https://codeScanner.dev');
$driver->setSemanticVersion('1.1.2-beta.12');

$rule = new ReportingDescriptor();
$rule->setId('CA2101');
$reportingConf = new ReportingConfiguration();
$reportingConf->setLevel('error');
$rule->setDefaultConfiguration($reportingConf);
$driver->addRules([$rule]);

$tool = new Tool();
$tool->setDriver($driver);

$ruleConf = new ReportingConfiguration();
$ruleConf->setLevel('warning');

$confOverrides = new ConfigurationOverride();
$descriptor = new ReportingDescriptorReference();
$descriptor->setIndex(0);
$confOverrides->setDescriptor($descriptor);
$confOverrides->setConfiguration($ruleConf);

$invocation = new Invocation();
$invocation->setExecutionSuccessful(true);
$invocation->addRuleConfigurationOverrides([$confOverrides]);

$run = new Run();
$run->setTool($tool);
$run->addInvocations([$invocation]);

$log = new SarifLog([$run]);

Note

This alternative API is available since release 1.5.0

examples/builder/configurationOverride.php

<?php declare(strict_types=1);
/**
 * This file is part of the Sarif-PHP-SDK package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Laurent Laville
 */

require_once dirname(__DIR__, 2) . '/vendor/autoload.php';

use Bartlett\Sarif\Factory\BuilderFactory;

$factory = new BuilderFactory();

// @link https://github.com/llaville/sarif-php-sdk/blob/1.1/docs/reference/configurationOverride.md
$spec = $factory->specification('2.1.0')
    ->addRun(
        $factory->run()
            ->tool(
                $factory->tool()
                    ->driver(
                        $factory->driver()
                            ->name('CodeScanner')
                            ->semanticVersion('1.1.2-beta.12')
                            ->informationUri('https://codeScanner.dev')
                            ->addRule(
                                $factory->rule()
                                    ->id('CA2101')
                                    ->defaultConfiguration(
                                        $factory->configuration()
                                            ->enabled(true)
                                            ->level('error')
                                            ->rank(-1)
                                    )
                            )
                    )
            )
            ->addInvocation(
                $factory->invocation()
                    ->executionSuccessful(true)
                    ->addRuleConfigurationOverride(
                        $factory->configurationOverride()
                            ->configuration(
                                $factory->configuration()
                                    ->enabled(true)
                                    ->level('warning')
                                    ->rank(-1)
                            )
                            ->descriptor(
                                $factory->descriptor()
                                    ->index(0)
                            )
                    )
            )
    )
;