SpringCloud/spring-cloud-config
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

handler for the gitee webhook format.

Browse Source 
https://gitee.com is the most popular git server in China.
Fixes https://github.com/spring-cloud/spring-cloud-config/issues/898
This commit is contained in:
廖师兄
2018-02-05 15:02:05 +08:00
committed by 廖师兄
parent 40880bf7bd
commit f208c016e6
6 changed files with 168 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/main/asciidoc/spring-cloud-config.adoc
View File

@@ -1220,7 +1220,7 @@ annotation (just set `spring.cloud.config.server.bootstrap=true`).
== Push Notifications and Spring Cloud Bus
Many source code repository providers (like Github, Gitlab or Bitbucket
Many source code repository providers (like Github, Gitlab, Gitee or Bitbucket
for instance) will notify you of changes in a repository through a
webhook. You can configure the webhook via the provider's user
interface as a URL and a set of events in which you are
@@ -1242,8 +1242,8 @@ if you want to override the behaviour is `PropertyPathNotificationExtractor`
which accepts the request headers and body as parameters and returns a list
of file paths that changed.
The default configuration works out of the box with Github, Gitlab or
Bitbucket. In addition to the JSON notifications from Github, Gitlab
The default configuration works out of the box with Github, Gitlab, Gitee or
Bitbucket. In addition to the JSON notifications from Github, Gitlab, Gitee
or Bitbucket you can trigger a change notification by POSTing to
"/monitor" with a form-encoded body parameters `path={name}`. This will
broadcast to applications matching the "{name}" pattern (can contain

5
spring-cloud-config-monitor/src/main/java/org/springframework/cloud/config/monitor/EnvironmentMonitorAutoConfiguration.java
View File

@@ -64,6 +64,11 @@ public class EnvironmentMonitorAutoConfiguration {
return new BitbucketPropertyPathNotificationExtractor();
}
@Bean
@ConditionalOnProperty(value="spring.cloud.config.server.monitor.gitee.enabled", havingValue="true", matchIfMissing=true)
public GiteePropertyPathNotificationExtractor giteePropertyPathNotificationExtractor() {
return new GiteePropertyPathNotificationExtractor();
}
}
}

49
spring-cloud-config-monitor/src/main/java/org/springframework/cloud/config/monitor/GiteePropertyPathNotificationExtractor.java Normal file
View File

@@ -0,0 +1,49 @@
/*
* Copyright 2015 the original author or authors.
*
* 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.
*/
package org.springframework.cloud.config.monitor;
import java.util.Collection;
import java.util.Map;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.util.MultiValueMap;
/**
* @author lly835
*
*/
@Order(Ordered.LOWEST_PRECEDENCE - 100)
public class GiteePropertyPathNotificationExtractor
implements PropertyPathNotificationExtractor {
private static final String HEADERS_KEY = "x-git-oschina-event";
private static final String HEADERS_VALUE = "Push Hook";
@Override
public PropertyPathNotification extract(MultiValueMap<String, String> headers,
Map<String, Object> request) {
if (HEADERS_VALUE.equals(headers.getFirst(HEADERS_KEY))) {
if (request.get("commits") instanceof Collection &&
((Collection<Map<String, Object>>) request.get("commits")).size() > 0) {
return new PropertyPathNotification("application.yml");
}
}
return null;
}
}

4
spring-cloud-config-monitor/src/test/java/org/springframework/cloud/config/monitor/EnvironmentMonitorAutoConfigurationTests.java
View File

@@ -47,7 +47,7 @@ public class EnvironmentMonitorAutoConfigurationTests {
PropertyPlaceholderAutoConfiguration.class).properties("server.port=-1")
.run();
PropertyPathEndpoint endpoint = context.getBean(PropertyPathEndpoint.class);
assertEquals(4,
assertEquals(5,
((Collection<?>) ReflectionTestUtils.getField(
ReflectionTestUtils.getField(endpoint, "extractor"),
"extractors")).size());
@@ -63,7 +63,7 @@ public class EnvironmentMonitorAutoConfigurationTests {
PropertyPlaceholderAutoConfiguration.class).properties("server.port=-1")
.run();
PropertyPathEndpoint endpoint = context.getBean(PropertyPathEndpoint.class);
assertEquals(5,
assertEquals(6,
((Collection<?>) ReflectionTestUtils.getField(
ReflectionTestUtils.getField(endpoint, "extractor"),
"extractors")).size());

64
spring-cloud-config-monitor/src/test/java/org/springframework/cloud/config/monitor/GiteePropertyPathNotificationExtractorTests.java Normal file
View File

@@ -0,0 +1,64 @@
/*
* Copyright 2015 the original author or authors.
*
* 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.
*/
package org.springframework.cloud.config.monitor;
import java.util.Map;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.Test;
import org.springframework.core.io.ClassPathResource;
import org.springframework.http.HttpHeaders;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
/**
* @author lly835
*
*/
public class GiteePropertyPathNotificationExtractorTests {
private GiteePropertyPathNotificationExtractor extractor = new GiteePropertyPathNotificationExtractor();
private HttpHeaders headers = new HttpHeaders();
@Test
public void githubSample() throws Exception {
// See http://git.mydoc.io/?t=154711
Map<String, Object> value = new ObjectMapper().readValue(
new ClassPathResource("gitee.json").getInputStream(),
new TypeReference<Map<String, Object>>() {
});
this.headers.set("x-git-oschina-event", "Push Hook");
PropertyPathNotification extracted = this.extractor.extract(this.headers, value);
assertNotNull(extracted);
assertEquals("application.yml", extracted.getPaths()[0]);
}
@Test
public void notAPushNotDetected() throws Exception {
Map<String, Object> value = new ObjectMapper().readValue(
new ClassPathResource("github.json").getInputStream(),
new TypeReference<Map<String, Object>>() {
});
this.headers.set("x-git-oschina-event", "Issue Hook");
PropertyPathNotification extracted = this.extractor.extract(this.headers, value);
assertNull(extracted);
}
}

45
spring-cloud-config-monitor/src/test/resources/gitee.json Normal file
View File

@@ -0,0 +1,45 @@
{
"before": "fb32ef5812dc132ece716a05c50c7531c6dc1b4d",
"after": "ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"ref": "refs/heads/master",
"user_id": 13,
"user_name": "123",
"user": {
"name": "123",
"username": "test123",
"url": "https://gitee.com/oschina"
},
"repository": {
"name": "webhook",
"url": "http://git.oschina.net/oschina/webhook",
"description": "",
"homepage": "https://gitee.com/oschina/webhook"
},
"commits": [{
"id": "ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"message": "1234 bug fix",
"timestamp": "2016-12-09T17:28:02 08:00",
"url": "https://gitee.com/oschina/webhook/commit/ac63b9ba95191a1bf79d60bc262851a66c12cda1",
"author": {
"name": "123",
"email": "123@123.com",
"time": "2016-12-09T17:28:02 08:00"
}
}],
"total_commits_count": 1,
"commits_more_than_ten": false,
"project": {
"name": "webhook",
"path": "webhook",
"url": "https://gitee.com/oschina/webhook",
"git_ssh_url": "git@gitee.com:oschina/webhook.git",
"git_http_url": "https://gitee.com/oschina/webhook.git",
"git_svn_url": "svn://gitee.com/oschina/webhook",
"namespace": "oschina",
"name_with_namespace": "oschina/webhook",
"path_with_namespace": "oschina/webhook",
"default_branch": "master"
},
"hook_name": "push_hooks",
"password": "pwd"
}