checkstyle: Require header for test files

awslabs · Nov 16, 2023 · 7299fc4 · 7299fc4
1 parent e06de34
commit 7299fc4
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 15 deletions.
diff --git a/.checkstyle/suppressions.xml b/.checkstyle/suppressions.xml
@@ -19,8 +19,8 @@
         "-//Puppy Crawl//DTD Suppressions 1.2//EN"
         "http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
 <suppressions>
-    <!-- ignore all checks for test classes -->
-    <suppress checks="^.*$"
+    <!-- ignore all checks for test classes except for the Header -->
+    <suppress checks="^((?!Header).)*$"
               files=".*[\\/](test|integrationTest)[\\/]java[\\/].+\.java$"/>
 
     <suppress checks="HideUtilityClassConstructor"

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/Containers.java b/src/integrationTest/java/software/amazon/nio/spi/s3/Containers.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.testcontainers.containers.localstack.LocalStackContainer;

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/FilesCopyTest.java b/src/integrationTest/java/software/amazon/nio/spi/s3/FilesCopyTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.DisplayName;

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/FilesDirectoryStreamTest.java b/src/integrationTest/java/software/amazon/nio/spi/s3/FilesDirectoryStreamTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.DisplayName;

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/FilesExistsTest.java b/src/integrationTest/java/software/amazon/nio/spi/s3/FilesExistsTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.BeforeEach;

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/FilesReadTest.java b/src/integrationTest/java/software/amazon/nio/spi/s3/FilesReadTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.BeforeAll;

diff --git a/src/integrationTest/java/software/amazon/nio/spi/s3/FilesWriteTest.java b/src/integrationTest/java/software/amazon/nio/spi/s3/FilesWriteTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.BeforeAll;

diff --git a/src/test/java/software/amazon/nio/spi/s3/FileSystemsTest.java b/src/test/java/software/amazon/nio/spi/s3/FileSystemsTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.DisplayName;

diff --git a/src/test/java/software/amazon/nio/spi/s3/S3BasicFileAttributesTest.java b/src/test/java/software/amazon/nio/spi/s3/S3BasicFileAttributesTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.BeforeAll;

diff --git a/src/test/java/software/amazon/nio/spi/s3/S3Matchers.java b/src/test/java/software/amazon/nio/spi/s3/S3Matchers.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.mockito.ArgumentMatchers;

diff --git a/src/test/java/software/amazon/nio/spi/s3/S3TransferUtilTest.java b/src/test/java/software/amazon/nio/spi/s3/S3TransferUtilTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.DisplayName;

diff --git a/src/test/java/software/amazon/nio/spi/s3/S3WritableByteChannelTest.java b/src/test/java/software/amazon/nio/spi/s3/S3WritableByteChannelTest.java
@@ -1,3 +1,8 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package software.amazon.nio.spi.s3;
 
 import org.junit.jupiter.api.DisplayName;

diff --git a/src/test/java/software/amazon/nio/spi/s3/S3XFileSystemProviderTest.java b/src/test/java/software/amazon/nio/spi/s3/S3XFileSystemProviderTest.java
@@ -1,17 +1,6 @@
 /*
- * Copyright 2023 ste.
- *
- * 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.
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 package software.amazon.nio.spi.s3;