🚀 1.0 release

MartinWitt · MartinWitt · commit c96ccf2e7fa9 · 2022-02-10T09:31:04.000+01:00
diff --git a/.github/workflows/buildProject.yml b/.github/workflows/buildProject.yml
@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Java CI with Gradle
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 11
+      uses: actions/setup-java@v2
+      with:
+        java-version: '11'
+        distribution: 'temurin'
+    - name: Build with Gradle
+      uses: gradle/gradle-build-action@937999e9cc2425eddc7fd62d1053baf041147db7
+      with:
+        arguments: build
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Martin Wittlinger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,26 @@
+## GithubIssue
+
+`GithubIssue` provides a simple way to mark test cases with open issue.
+`@GitHubIssue(issueNumber = <your issue number>, fixed = boolean)` is used to mark test cases with open issue.
+If a test case has this annotation and `fixed = false` it must fail. If it doesn't fail it will be marked as failed.
+Any test case with this annotation and `fixed = true` behaves like a normal unit test.
+We use JUnit 5 annotation composition feature(https://junit.org/junit5/docs/current/user-guide/#writing-tests-meta-annotations), so you only need to add this annotation to your test method.
+
+## Example
+```java
+@GitHubIssue(issueNumber = 4218, fixed = false)
+void testSniperDoesNotPrintTheDeletedAnnotation() {
+	Consumer<CtType<?>> deleteAnnotation = type -> {
+		type.getAnnotations().forEach(CtAnnotation::delete);
+	};
+	BiConsumer<CtType<?>, String> assertDoesNotContainAnnotation = (type, result) ->
+			assertThat(result, not(containsString("@abc.def.xyz")));
+	testSniper("sniperPrinter.DeleteAnnotation", deleteAnnotation, assertDoesNotContainAnnotation);
+}
+```
+Internal `@GitHubIssue` combines `@Test` and `@ExtendWith` annotation with an extension enforcing the specified behavior.
+
+## Original Idea
+
+The original idea and implementation is from Spoon(https://github.com/INRIA/spoon) and discussed in this issue https://github.com/INRIA/spoon/issues/3001.
+The code is copied with permission from Spoon.
diff --git a/build.gradle b/build.gradle
@@ -2,11 +2,22 @@ plugins {
 	// Apply the java-library plugin for API and implementation separation.
 	id 'java-library'
 	id "com.diffplug.spotless" version "6.2.2"
+	id 'maven-publish'
+	id "com.vanniktech.maven.publish" version "0.18.0"
+	id "signing"
 }
 
+group = 'io.github.martinwitt'
+version = '1.0'
 repositories {
 	// Use Maven Central for resolving dependencies.
+	mavenLocal()
 	mavenCentral()
+	gradlePluginPortal()
+}
+
+tasks.withType(JavaCompile) {
+	options.encoding = 'UTF-8'
 }
 
 dependencies {
@@ -34,11 +45,16 @@ spotless {
 		endWithNewline()
 	}
 	java {
-
 		palantirJavaFormat()
 	}
 	groovyGradle {
 		target '*.gradle' // default target of groovyGradle
 		greclipse()
 	}
 }
+
+plugins.withId("com.vanniktech.maven.publish") {
+	mavenPublish {
+		sonatypeHost = "S01"
+	}
+}
diff --git a/gradle.properties b/gradle.properties
@@ -0,0 +1,20 @@
+GROUP=io.github.martinwitt
+POM_ARTIFACT_ID=GithubIssue
+VERSION_NAME=1.0
+
+POM_NAME=GithubIssue
+POM_DESCRIPTION=GithubIssue provides a simple way to enforce failing test cases.
+POM_INCEPTION_YEAR=2022
+POM_URL=https://github.com/MartinWitt/GithubIssue
+
+POM_LICENSE_NAME=MIT LICENSE
+POM_LICENSE_URL=https://opensource.org/licenses/MIT
+POM_LICENSE_DIST=repo
+
+POM_SCM_URL=https://github.com/MartinWitt/GithubIssue
+POM_SCM_CONNECTION=scm:git:git://github.com/MartinWitt/GithubIssue.git
+POM_SCM_DEV_CONNECTION=scm:git:ssh://github.com/MartinWitt/GithubIssue.git
+
+POM_DEVELOPER_ID=martinWitt
+POM_DEVELOPER_NAME=Martin Wittlinger
+POM_DEVELOPER_URL=https://github.com/martinWitt/
diff --git a/gradlew b/gradlew
diff --git a/settings.gradle b/settings.gradle
@@ -8,4 +8,3 @@
  */
 
 rootProject.name = 'GithubIssue'
-include('lib')
diff --git a/src/main/java/io/github/martinwitt/testing/GitHubIssue.java b/src/main/java/io/github/martinwitt/testing/GitHubIssue.java

Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,3 @@`
`8`	`8`	`*/`
`9`	`9`
`10`	`10`	`rootProject.name = 'GithubIssue'`
`11`		`-include('lib')`