From e6825c4fadc0a7950652178111baf0cf4d51f82f Mon Sep 17 00:00:00 2001 From: Haotian Zhang <928016560@qq.com> Date: Tue, 14 Feb 2023 10:02:16 +0800 Subject: [PATCH] docs:Add license checker GitHub Action. (#841) * docs:Add license checker GitHub Action. * docs:Add license checker GitHub Action. --- .github/PULL_REQUEST_TEMPLATE.md | 1 - .github/workflows/licence-checker.yml | 25 +++++++++++++++++++ .licenserc.yaml | 23 +++++++++++++++++ CHANGELOG.md | 1 + .../config/adapter/MockedConfigChange.java | 17 +++++++++++++ .../common/util/BeanFactoryUtilsTest.java | 17 +++++++++++++ .../context/PolarisContextGetHostTest.java | 13 +++++++--- .../PolarisContextAutoConfigurationTest.java | 3 +-- .../src/test/resources/bootstrap.yml | 2 ++ .../RpcEnhancementBootstrapConfiguration.java | 17 +++++++++++++ 10 files changed, 112 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/licence-checker.yml create mode 100644 .licenserc.yaml rename spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/{ => config}/PolarisContextAutoConfigurationTest.java (93%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5acc60650..e516afb42 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,7 +21,6 @@ fixes # ## Checklist -- [ ] Add copyright holder at the beginning of .java file if it is new. - [ ] Add information of this PR to CHANGELOG.md in root of project. - [ ] Add documentation in javadoc or comment below the PR if necessary. diff --git a/.github/workflows/licence-checker.yml b/.github/workflows/licence-checker.yml new file mode 100644 index 000000000..e5e639135 --- /dev/null +++ b/.github/workflows/licence-checker.yml @@ -0,0 +1,25 @@ +name: License checker + +on: + push: + branches: + - 2022.0 + - 2021.0 + - 2020.0 + - hoxton + - greenwich + pull_request: + branches: + - 2022.0 + - 2021.0 + - 2020.0 + - hoxton + - greenwich +jobs: + check-license: + runs-on: ubuntu-latest + steps: + - name: Checkout codes + uses: actions/checkout@v3 + - name: Check License Header + uses: apache/skywalking-eyes@v0.4.0 diff --git a/.licenserc.yaml b/.licenserc.yaml new file mode 100644 index 000000000..32266c414 --- /dev/null +++ b/.licenserc.yaml @@ -0,0 +1,23 @@ +header: + license: + content: | + Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + + Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. + + Licensed under the BSD 3-Clause License (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://opensource.org/licenses/BSD-3-Clause + + 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. + paths: + - "**/java/**" + language: + Java: + extensions: + - ".java" diff --git a/CHANGELOG.md b/CHANGELOG.md index 034f33055..650c198a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,3 +2,4 @@ --- - [docs:Add code coverage blocking.](https://github.com/Tencent/spring-cloud-tencent/pull/837) +- [docs:Add license checker GitHub Action.](https://github.com/Tencent/spring-cloud-tencent/pull/841) diff --git a/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigChange.java b/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigChange.java index c1a20c9c0..2545414d7 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigChange.java +++ b/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigChange.java @@ -1,3 +1,20 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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. + */ + package com.tencent.cloud.polaris.config.adapter; /** diff --git a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/util/BeanFactoryUtilsTest.java b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/util/BeanFactoryUtilsTest.java index aa1b4b491..36dbd7e9d 100644 --- a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/util/BeanFactoryUtilsTest.java +++ b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/util/BeanFactoryUtilsTest.java @@ -1,3 +1,20 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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. + */ + package com.tencent.cloud.common.util; import org.junit.Assert; diff --git a/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextGetHostTest.java b/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextGetHostTest.java index 71a332cba..21e9e4b29 100644 --- a/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextGetHostTest.java +++ b/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextGetHostTest.java @@ -20,7 +20,6 @@ package com.tencent.cloud.polaris.context; import com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration; import com.tencent.cloud.polaris.context.config.PolarisContextProperties; import com.tencent.polaris.client.api.SDKContext; -import org.junit.Assert; import org.junit.Test; import org.junit.platform.commons.util.StringUtils; import org.junit.runner.RunWith; @@ -30,6 +29,8 @@ import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; +import static org.assertj.core.api.Assertions.assertThat; + @RunWith(SpringRunner.class) @SpringBootTest(classes = PolarisContextApplication.class, properties = {"spring.config.location = classpath:bootstrap.yml"}) @@ -45,8 +46,12 @@ public class PolarisContextGetHostTest { @Test public void testGetConfigHost() { String bindIP = polarisContext.getConfig().getGlobal().getAPI().getBindIP(); - Assert.assertFalse(StringUtils.isBlank(bindIP)); - Assert.assertEquals(bindIP, "192.168.1.1"); - Assert.assertEquals(polarisContextProperties.getNamespace(), "dev"); + assertThat(StringUtils.isBlank(bindIP)).isFalse(); + assertThat(bindIP).isEqualTo("192.168.1.1"); + assertThat(polarisContextProperties.getAddress()).isEqualTo("grpc://127.0.0.1:8091"); + assertThat(polarisContextProperties.getLocalIpAddress()).isEqualTo("192.168.1.1"); + assertThat(polarisContextProperties.getEnabled()).isTrue(); + assertThat(polarisContextProperties.getNamespace()).isEqualTo("dev"); + assertThat(polarisContextProperties.getService()).isEqualTo("TestApp"); } } diff --git a/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextAutoConfigurationTest.java b/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/config/PolarisContextAutoConfigurationTest.java similarity index 93% rename from spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextAutoConfigurationTest.java rename to spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/config/PolarisContextAutoConfigurationTest.java index b31a34096..c5c5e7b0d 100644 --- a/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/PolarisContextAutoConfigurationTest.java +++ b/spring-cloud-tencent-polaris-context/src/test/java/com/tencent/cloud/polaris/context/config/PolarisContextAutoConfigurationTest.java @@ -15,9 +15,8 @@ * specific language governing permissions and limitations under the License. */ -package com.tencent.cloud.polaris.context; +package com.tencent.cloud.polaris.context.config; -import com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration; import com.tencent.polaris.client.api.SDKContext; import org.junit.Assert; import org.junit.Test; diff --git a/spring-cloud-tencent-polaris-context/src/test/resources/bootstrap.yml b/spring-cloud-tencent-polaris-context/src/test/resources/bootstrap.yml index 7b2284774..c8ae7edeb 100644 --- a/spring-cloud-tencent-polaris-context/src/test/resources/bootstrap.yml +++ b/spring-cloud-tencent-polaris-context/src/test/resources/bootstrap.yml @@ -4,3 +4,5 @@ spring: local-ip-address: 192.168.1.1 address: grpc://127.0.0.1:8091 namespace: dev + service: TestApp + enabled: true diff --git a/spring-cloud-tencent-rpc-enhancement/src/main/java/com/tencent/cloud/rpc/enhancement/config/RpcEnhancementBootstrapConfiguration.java b/spring-cloud-tencent-rpc-enhancement/src/main/java/com/tencent/cloud/rpc/enhancement/config/RpcEnhancementBootstrapConfiguration.java index d2d6d47b7..32fb91194 100644 --- a/spring-cloud-tencent-rpc-enhancement/src/main/java/com/tencent/cloud/rpc/enhancement/config/RpcEnhancementBootstrapConfiguration.java +++ b/spring-cloud-tencent-rpc-enhancement/src/main/java/com/tencent/cloud/rpc/enhancement/config/RpcEnhancementBootstrapConfiguration.java @@ -1,3 +1,20 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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. + */ + package com.tencent.cloud.rpc.enhancement.config; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;