Merge pull request #418 from Juniper/add-license-headers

Add license headers
Juniper · Sep 22, 2024 · d13e3a6 · d13e3a6
2 parents bd2300a + f473189
commit d13e3a6
Show file tree

Hide file tree

Showing 212 changed files with 859 additions and 7 deletions.
diff --git a/.ci/scripts/gofmt_check.sh b/.ci/scripts/gofmt_check.sh
@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# Copyright (c) Juniper Networks, Inc., 2022-2024.
+# All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
 echo -n "Check formatting... "
 require_formatting=$(gofmt -l .)
 

diff --git a/.ci/scripts/gofumpt_check.sh b/.ci/scripts/gofumpt_check.sh
@@ -1,4 +1,9 @@
 #!/usr/bin/env bash
+
+# Copyright (c) Juniper Networks, Inc., 2024-2024.
+# All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 # init array of files which need updating by gofumpt

diff --git a/.ci/scripts/license_header_check.sh b/.ci/scripts/license_header_check.sh
@@ -15,7 +15,7 @@ skip_regexes+=("^Third_Party_Code/.*$")
 skip_regexes+=("^\.gitignore$")
 skip_regexes+=("^\.notices.tpl$")
 
-copyright_template="Copyright \(c\) Juniper Networks, Inc\., %s-%s\."
+copyright_template="Copyright \\(c\\) Juniper Networks, Inc\\., %s-%s\\."
 arr_line="All rights reserved\."
 spdx_line="SPDX-License-Identifier: Apache-2.0"
 leading_comment="[ #/]{0,3}"
@@ -39,7 +39,7 @@ do
   [ -n "$skip" ] && printf "skipping %s" "$file" && continue
 
   # shellcheck disable=SC2059
-  printf "checking %s\n" "$file"
+  printf "checking %s...  " "$file"
 
   # determine the the the file was introduced and the year it was most recently modified
   first_year=""
@@ -52,10 +52,11 @@ do
     else
       first_year="$line"
     fi
-  done <<< "$(git log --follow --pretty=format:"%ad" --date=format:'%Y' "$file" | sed -n '1p;$p')"
+  done <<< "$((git log --follow --pretty=format:"%ad" --date=format:'%Y' "$file"; echo) | sed -n '1p;$p')"
 
   # assume current year for both values if git log didn't find anything (new file)
-  [ -z "$first_year" ] && [ -z "$recent_year" ] && first_year=$(date '+%Y') && recent_year=$(date '+%Y')
+  [ -z "$first_year" ] && first_year=$(date '+%Y')
+  [ -z "$recent_year" ] && recent_year=$(date '+%Y')
 
   # shellcheck disable=SC2059
   copyright_line=$(printf "${copyright_template}" "$first_year" "$recent_year")
@@ -69,8 +70,11 @@ do
   grep -Eq "${leading_comment}${arr_line}"       <<< "$head" || ((failed+=2))
   grep -Eq "${leading_comment}${spdx_line}"      <<< "$head" || ((failed+=4))
 
-  if [ "$failed" -gt 0 ]
+  if [ "$failed" -eq 0 ]
   then
+    echo "ok"
+  else
+    echo "failure reason: $failed"
     problem_files+=("$file")
     problem_headers+=("${copyright_line//\\/}\n${arr_line//\\/}\n${spdx_line//\\/}")
   fi

diff --git a/.github/workflows/go_tools.yml b/.github/workflows/go_tools.yml
@@ -1,3 +1,7 @@
+# Copyright (c) Juniper Networks, Inc., 2023-2024.
+# All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
 name: Go package
 
 on: [push]

diff --git a/.github/workflows/license_header_check.yml b/.github/workflows/license_header_check.yml
@@ -13,7 +13,14 @@ jobs:
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
+      - name: fetch main
+        run: |
+          git fetch origin main
+
+      - name: unshallow
+        run: |
+          git pull --unshallow
+
       - name: license header check
         run: |
-          git fetch origin main --depth 1
-          make fumpt-check
+          make license-header-check
diff --git a/apstra/api_anomalies.go b/apstra/api_anomalies.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_anomalies_integration_test.go b/apstra/api_anomalies_integration_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_blueprints.go b/apstra/api_blueprints.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_blueprints_deploy.go b/apstra/api_blueprints_deploy.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_blueprints_deploy_test.go b/apstra/api_blueprints_deploy_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import "testing"

diff --git a/apstra/api_blueprints_integration_test.go b/apstra/api_blueprints_integration_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_config.go b/apstra/api_config.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 const (

diff --git a/apstra/api_config_audit.go b/apstra/api_config_audit.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design.go b/apstra/api_design.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 const (

diff --git a/apstra/api_design_configlet_structures.go b/apstra/api_design_configlet_structures.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_configlets.go b/apstra/api_design_configlets.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_configlets_test.go b/apstra/api_design_configlets_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_design_interface_map_digests.go b/apstra/api_design_interface_map_digests.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_interface_map_digests_test.go b/apstra/api_design_interface_map_digests_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_design_interface_maps.go b/apstra/api_design_interface_maps.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_interface_maps_test.go b/apstra/api_design_interface_maps_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_design_logical_devices.go b/apstra/api_design_logical_devices.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_logical_devices_integration_test.go b/apstra/api_design_logical_devices_integration_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2024-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_design_logical_devices_unit_test.go b/apstra/api_design_logical_devices_unit_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2024-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_rack_types.go b/apstra/api_design_rack_types.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_rack_types_test.go b/apstra/api_design_rack_types_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_design_tags.go b/apstra/api_design_tags.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_tags_test.go b/apstra/api_design_tags_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_design_templates.go b/apstra/api_design_templates.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_design_templates_test.go b/apstra/api_design_templates_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_device_profiles.go b/apstra/api_device_profiles.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_device_profiles_modular.go b/apstra/api_device_profiles_modular.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_device_profiles_modular_test.go b/apstra/api_device_profiles_modular_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_device_profiles_test.go b/apstra/api_device_profiles_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_features.go b/apstra/api_features.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2024-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_features_integration_test.go b/apstra/api_features_integration_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2024-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_iba_dashboards.go b/apstra/api_iba_dashboards.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_iba_dashboards_test.go b/apstra/api_iba_dashboards_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2022-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 
 package apstra

diff --git a/apstra/api_iba_predefined_probes.go b/apstra/api_iba_predefined_probes.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_iba_predefined_probes_test.go b/apstra/api_iba_predefined_probes_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_iba_probes.go b/apstra/api_iba_probes.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (

diff --git a/apstra/api_iba_probes_test.go b/apstra/api_iba_probes_test.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 //go:build integration
 // +build integration
 

diff --git a/apstra/api_iba_widgets.go b/apstra/api_iba_widgets.go
@@ -1,3 +1,7 @@
+// Copyright (c) Juniper Networks, Inc., 2023-2024.
+// All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 package apstra
 
 import (