Skip to content

Commit

Permalink
Merge branch 'MicroShed:main' into feature/testcontainers-update
Browse files Browse the repository at this point in the history
  • Loading branch information
appiepollo14 authored Nov 7, 2023
2 parents 67c04a1 + 0cfc228 commit 4f82170
Show file tree
Hide file tree
Showing 9 changed files with 85 additions and 41 deletions.
18 changes: 0 additions & 18 deletions .dependabot/config.yml

This file was deleted.

6 changes: 0 additions & 6 deletions .github/CODEOWNERS

This file was deleted.

11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily

- package-ecosystem: gradle
directory: /
schedule:
interval: daily
2 changes: 1 addition & 1 deletion .github/workflows/microshed-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: MicroShed CI
on:
pull_request:
branches:
- master
- main
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '.gitignore'
Expand Down
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to MicroProfile Starter Extension for VS Code

We welcome contributions, and request you follow these guidelines.

- [Raising issues](#raising-issues)
- [Legal](#legal)
- [Coding Standards](#coding-standards)
- [Project Setup](#project-setup)

### Raising issues

Please raise any bug reports on the [issue tracker](https://github.com/MicroShed/microshed-testing/issues). Be sure to search the list to see if your issue has already been raised.

A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.

### Legal

In order to make contribution as easy as possible, we follow the same approach as the [Developer's Certificate of Origin 1.1 (DCO)](https://developercertificate.org/) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin) uses to manage code contributions.

We simply ask that when submitting a pull request for review, the developer
must include a sign-off statement in the commit message.

Here is an example Signed-off-by line, which indicates that the
submitter accepts the DCO:

```text
Signed-off-by: John Doe <[email protected]>
```

You can include this automatically when you commit a change to your
local git repository using the following command:

```bash
git commit -s
```

### Coding Standards

This project contains a CI build that should run successfully.
Upon opening a Pull Request or Merging a commit this build will run.
If your Pull Request results in the failure of this build it will not be reviewed or merged until the failure is fixed.

### Project Setup

##### Requirements

- JDK 8 or higher
- Docker (daemon or desktop)
<!-- TODO support podman/colima for builds -->

##### Building project

Use the gradle wrapper to build this project:

```sh
./gradlew build
```
26 changes: 13 additions & 13 deletions docs/features/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ Sometimes code is worth a thousand words. Here are some pointers to working exam

## General Examples

- [Basic JAX-RS application using Gradle](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-json)
- [Basic JAX-RS application using Maven](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/maven-app)
- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)
- [JAX-RS and JDBC application using a PostgreSQL database](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jdbc-app)
- [JAX-RS application secured with Basic Auth](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-basicauth)
- [JAX-RS application secured with MP JWT](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/jaxrs-mpjwt)
- [JAX-RS and MongoDB application that depends on an external REST service](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/everything-app)
- [Application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/kafka-app)
- [Application with no Dockerfile using OpenLiberty adapter](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app)
- [Basic JAX-RS application using Gradle](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-json)
- [Basic JAX-RS application using Maven](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/maven-app)
- [Basic JAX-RS application using REST Assured](https://github.com/MicroShed/microshed-testing/blob/main/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)
- [JAX-RS and JDBC application using a PostgreSQL database](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jdbc-app)
- [JAX-RS application secured with Basic Auth](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-basicauth)
- [JAX-RS application secured with MP JWT](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/jaxrs-mpjwt)
- [JAX-RS and MongoDB application that depends on an external REST service](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/everything-app)
- [Application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/kafka-app)
- [Application with no Dockerfile using OpenLiberty adapter](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/liberty-app)

## Runtime examples:

- [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app)
- [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/payara-app)
- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/wildfly-app)
- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/quarkus-app)
- [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/liberty-app)
- [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/payara-app)
- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/wildfly-app)
- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/quarkus-app)
2 changes: 1 addition & 1 deletion docs/features/KafkaMessaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,6 @@ injected `consumer` to the specified `topics`.

## Additional resources

- [Example application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/kafka-app)
- [Example application using Apache Kafka messaging](https://github.com/MicroShed/microshed-testing/tree/main/sample-apps/kafka-app)
- [OpenLiberty blog on using MicroProfile Reactive Messaging](https://openliberty.io/blog/2019/09/13/microprofile-reactive-messaging.html)
- [Quarkus guide on using Apache Kafka with Reactive Messaging](https://quarkus.io/guides/kafka)
2 changes: 1 addition & 1 deletion docs/features/RestAssured.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ It is also possible to send/receive POJOs with the JSON-B based ObjectMapper:
}
```

For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/master/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)
For a complete working example, see the [RestAssuredTest class](https://github.com/MicroShed/microshed-testing/blob/main/sample-apps/everything-app/src/test/java/org/example/app/RestAssuredIT.java)

## Auto-configuration override

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ private String readMpRestClientConfigKey(Class<?> restClientClass) {
*/
public ApplicationContainer withMpRestClient(String restClientClass, String hostUri) {
// If we will be running in Docker, sanitize environment variable name using Environment Variables Mapping Rules defined in MP Config:
// https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules
// https://github.com/eclipse/microprofile-config/blob/main/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules
if (ApplicationEnvironment.Resolver.isSelected(TestcontainersConfiguration.class)) {
restClientClass = restClientClass.replaceAll("[^a-zA-Z0-9_]", "_") + "_mp_rest_url";
} else {
Expand Down

0 comments on commit 4f82170

Please sign in to comment.