Changing to SPDX style and add checker

Signed-off-by: Erik Jaegervall <[email protected]>

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max_line_length = 120

.github/actions/verify-headers/action.yml

@@ -0,0 +1,17 @@
+name: verify-headers
+description: Verify that files affected by a PR include expected header
+
+branding:
+  icon: zap
+  color: gray-dark
+
+inputs:
+  files:
+    description: >
+      A comma-separated list of all files to check.
+    default: ''
+runs:
+  using: "composite"
+  steps:
+    - run: $GITHUB_ACTION_PATH/verify-headers.py
+      shell: bash

.github/actions/verify-headers/verify-headers.py

@@ -0,0 +1,38 @@
+#!/usr/bin/python3
+# Copyright (c) 2023 Contributors to COVESA
+#
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
+import os
+
+
+def string_exists(file_path, search_string) -> bool:
+    with open(file_path, 'r') as file:
+        content = file.read()
+        if search_string in content:
+            return True
+    return False
+
+
+if __name__ == '__main__':
+
+    files = os.getenv('files')
+    files = files.split(',')
+    for file in files:
+        file = os.path.abspath(file)
+        if os.path.isfile(file):
+            ext = os.path.splitext(file)[1]
+            if ext in [".vspec", ".py"]:
+                if not string_exists(file, "Contributors to COVESA"):
+                    print(f"No contribution statement found in {file}")
+                    raise Exception("Check the output, some files have not the right contribution statement!")
+                if not string_exists(file, "SPDX-License-Identifier: MPL-2.0"):
+                    print(f"Incorrect license statement found in {file}")
+                    raise Exception("Check the output, some files have not the right SPDX statement!")
+
+                print(f"Check succeeded for {file}")
+    raise SystemExit(0)

.github/workflows/check-header.yml

@@ -0,0 +1,28 @@
+name: check-header
+
+on:
+  pull_request
+
+concurrency:
+      group: ${{ github.ref }}-${{ github.workflow }}
+      cancel-in-progress: true
+
+jobs:
+  check-headers:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        # required to grab the history of the PR
+        fetch-depth: 0
+
+    - name: Get changed files
+      run: |
+        echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} | tr '\n' ',')" >> $GITHUB_ENV
+
+    - uses: ./.github/actions/verify-headers
+      with:
+        files: "${{ env.files }}"

CONTRIBUTING.md

@@ -63,15 +63,25 @@ By supplying this sign-off line, you indicate your acceptance of the COVESA Cert
 
 If using git command line you can add a sign-off by using the `-s` argument when creating a commit.
 
-Each file shall have copyright statement of this form, inspired by the [Eclipse generic copyright header](https://www.eclipse.org/projects/handbook/#ip-copyright-headers)
+For certain files it is requested that a copyright and license statement is added as file header.
+This currently applies to the following file types:
+
+* VSS source files (`*.vspec`)
+* Python files (vss-tools, `*.py`)
+
+Those files shall have copyright statement of this form, inspired by the [Eclipse generic copyright header](https://www.eclipse.org/projects/handbook/#ip-copyright-headers).
+Copyright/License-statement may also be added to other files if considered relevant.
 
 ```
-# Copyright (c) XXXX Contributors to COVESA
+# Copyright (c) {year} Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
-```
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
+```
 Where XXXX is the year the file was originally created, no need to update or append new years or a range of years later.
 
 ### VSS Signals shall be generic

overlays/extensions/dual_wiper_systems.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 # Overlay to extend wiper system to support multiple instances
 # Dependencies to other overlays: None

overlays/profiles/motorbike.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 # This file contains adoptions to the main spec concering motorbikes.
 # It mainly addresses istantiation issues (e.g. wheels) and

spec/ADAS/ADAS.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All Advanced Driver Assist System signals

spec/Body/Body.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All body signals and attributes.

spec/Body/BrakeLights.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 IsActive:
   datatype: string

spec/Body/ExteriorMirrors.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All exterior mirrors

spec/Body/SignalingLights.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 IsSignaling:
   datatype: boolean

spec/Body/StaticLights.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 IsOn:
   datatype: boolean

spec/Body/WiperSystem.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2022 Contributors to COVESA
+# Copyright (c) 2022 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 # This file describes signals for a wiper system interface, allowing movement for one or more wipers
 # to be controlled in great detail.

spec/Cabin/Cabin.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All in-cabin originated signals and attributes

spec/Cabin/HVAC.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All HVAC-originated signals

spec/Cabin/Infotainment.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # In-Vehicle Infotainment Signals

spec/Cabin/InteriorLights.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # All interior lights and sensors

spec/Cabin/Occupant.vspec

@@ -1,7 +1,11 @@
-## Copyright (c) 2020 Contributors to COVESA
+# Copyright (c) 2020 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
 #
 # Occupant data
 #

spec/Cabin/SingleConfigurableLight.vspec

@@ -1,7 +1,11 @@
-## Copyright (c) 2023 Contributors to COVESA
+# Copyright (c) 2023 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
 
 #
 # Generic specification for a light whose color and brightness can be configured.

spec/Cabin/SingleDoor.vspec

@@ -1,7 +1,11 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2023 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
+
 
 #
 # Definition of a single door. Start position for Door is Closed.

spec/Cabin/SingleHVACStation.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # A single HVAC station in the vehicle.

spec/Cabin/SingleSeat.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # Seat signals

spec/Chassis/Chassis.vspec

@@ -1,7 +1,10 @@
-## Copyright (c) 2016 Contributors to COVESA
+# Copyright (c) 2016 Contributors to COVESA
 #
-# All files and artifacts in this repository are licensed under the
-# provisions of the license provided by the LICENSE file in this repository.
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License 2.0 which is available at
+# https://www.mozilla.org/en-US/MPL/2.0/
+#
+# SPDX-License-Identifier: MPL-2.0
 
 #
 # Chassis signals and attributes