xref: /test/xts/dcts/OAT.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright (c) 2022 Huawei Device Co., Ltd.

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
-->
<!-- OAT(OSS Audit Tool) configuration guide:
basedir: Root dir, the basedir + project path is the real source file location.
licensefile:
1.If the project does not have "LICENSE" in root dir, please define all the license files in this project. OAT will check license files according to this rule.

tasklist(only for batch mode):
1. task: Define oat check thread. Each task will start a new thread.
2. task name: Only an name, no practical effect.
3. task policy: Default policy for projects under this task. This field is required and the specified policy must be defined in policylist.
4. task filter: Default filefilter for projects under this task. This field is required and the specified filefilter must be defined in filefilterlist.
5. task project: Projects to be checked. The path field defines the source root dir of the project.


policyList:
1. policy: All policyitems will be merged to default rules in OAT.xml.The name of policy does not affect the OAT check process.
2. policyitem: The type, name, path, and desc fields are required, and the rule, group, and filefilter fields are optional.The default value is:
<policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/>
3. policyitem type:
    "compatibility" is used to check license compatibility in the specified path;
    "license" is used to check source license header in the specified path;
    "copyright" is used to check source copyright header in the specified path;
    "import" is used to check source dependency in the specified path, such as import ... ,include ...
    "filetype" is used to check file type in the specified path, supported file types: archive, binary
    "filename" is used to check whether the specified file exists in the specified path(support projectroot in default OAT.xml), supported file names: LICENSE, README, README.OpenSource

4. policyitem name: This field is used to define the license, copyright. Wherein,"*" means matching of all, the "!" prefix means a failure to match this value. For example, "!GPL" means that the GPL license cannot be used.
5. policyitem path: This field is used to define the source file scope to apply this policyitem. Wherein,"!" prefix means to exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem.
6. policyitem rule and group: These two fields are used together to merge policy results. "may" policyitems in the same group means any one in this group passed, the result will be passed.
7. policyitem filefilter: This field is used to bind filefilter,which defines filter rules.
8. filefilter: Filter rules.The type filename is used to filter file names, and the type filepath is used to filter file paths.

Note:If the text contains special characters, please escape them according to the following rules:
" == &gt;
& == &gt;
' == &gt;
< == &gt;
> == &gt;
-->
<configuration>
    <oatconfig>
        <filefilterlist>
            <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binaryFile" >
                <filteritem type="filename" name="*.jpg" desc="all jpg file have check "/>
                <filteritem type="filename" name="*.gif" desc="all gif file have check "/>
                <filteritem type="filename" name="*.png" desc="all png file have check "/>
            </filefilter>
        </filefilterlist>
    </oatconfig>
</configuration>