Add PR builder GitHub Workflow for Code snippets (#1283)

This PR adds GitHub workflow to compile the Java code on pull requests (to verify the code still works with given Hazelcast version). It also adds a dependabot configuration. Originally the changes were part of the #1263
hazelcast · Sep 9, 2024 · b076f34 · b076f34
1 parent ff671a4
commit b076f34
Show file tree

Hide file tree

Showing 37 changed files with 267 additions and 72 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/maven-pr-builder.yaml b/.github/workflows/maven-pr-builder.yaml
@@ -0,0 +1,29 @@
+name: Compile Java source files
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**/*.java'
+      - 'pom.xml'
+      - 'docs/antora.yml'
+      - '.github/workflows/maven-pr-builder.yaml'
+  schedule:
+    - cron: '15 2 * * 0'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Maven compile
+        run: |
+          HZ_VERSION=$(grep full-version docs/antora.yml|sed "s/.*:[ ]*'\(.*\)'/\1/")
+          mvn --show-version --batch-mode --no-transfer-progress test "-Dhazelcast.version=$HZ_VERSION"
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,5 @@ package-lock.json
 .project
 .settings/
 .vscode/settings.json
+/target/
+.classpath
diff --git a/docs/modules/ROOT/examples/dds/map/Employee.java b/docs/modules/ROOT/examples/dds/map/Employee.java
@@ -1,7 +1,9 @@
+import com.hazelcast.core.HazelcastJsonValue;
+
 //tag::emp[]
 public class Employee {
     public static HazelcastJsonValue asJson(String surname) {
         return new HazelcastJsonValue("{ \"surname\": \"" + surname + "\" }");
     }
 }
-//end::emp[]
+//end::emp[]
diff --git a/docs/modules/ROOT/examples/dds/map/ListenerWithPredicate.java b/docs/modules/ROOT/examples/dds/map/ListenerWithPredicate.java
@@ -2,6 +2,7 @@
 import com.hazelcast.core.EntryEvent;
 import com.hazelcast.core.Hazelcast;
 import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.core.HazelcastJsonValue;
 import com.hazelcast.map.IMap;
 import com.hazelcast.map.listener.EntryAddedListener;
 import com.hazelcast.map.listener.EntryRemovedListener;
@@ -41,4 +42,4 @@ public void entryUpdated(EntryEvent<String, HazelcastJsonValue> event) {
         }
     }
 }
-//end::lwp[]
+//end::lwp[]
diff --git a/docs/modules/ROOT/examples/dds/map/Modify.java b/docs/modules/ROOT/examples/dds/map/Modify.java
diff --git a/docs/modules/ROOT/examples/dds/map/Supplement.java b/docs/modules/ROOT/examples/dds/map/Supplement.java
@@ -1,3 +1,5 @@
+package dds.map;
+
 import java.io.Serializable;
 
 
@@ -18,4 +20,4 @@ public String getName() {
     public Integer getPrice() {
         return price;
     }
-}
+}
diff --git a/docs/modules/ROOT/examples/dds/map/YourMapStoreImplementation.java b/docs/modules/ROOT/examples/dds/map/YourMapStoreImplementation.java
@@ -1,3 +1,5 @@
+package dds.map;
+
 import com.hazelcast.core.HazelcastInstance;
 import com.hazelcast.map.MapLoaderLifecycleSupport;
 import com.hazelcast.map.MapStore;
@@ -106,4 +108,4 @@ public void delete(String key) {
     public void deleteAll(Collection<String> keys) {
         this.collection.deleteMany(in("_id", keys));
     }
-}
+}
diff --git a/docs/modules/ROOT/examples/dds/queue/ConsumerMember.java b/docs/modules/ROOT/examples/dds/queue/ConsumerMember.java
@@ -7,17 +7,17 @@ public class ConsumerMember {
 
     public static void main( String[] args ) throws Exception {
         HazelcastInstance hz = Hazelcast.newHazelcastInstance();
-        IQueue<Integer> queue = hz.getQueue( "queue" ); <1>
+        IQueue<Integer> queue = hz.getQueue( "queue" ); // <1>
         while ( true ) {
-            int item = queue.take(); <2>
+            int item = queue.take(); // <2>
             System.out.println( "Consumed: " + item );
             if ( item == -1 ) {
                 queue.put( -1 );
                 break;
             }
-            Thread.sleep( 5000 ); <3>
+            Thread.sleep( 5000 ); // <3>
         }
         System.out.println( "Consumer Finished!" );
     }
 }
-//end::consumer[]
+//end::consumer[]
diff --git a/docs/modules/ROOT/examples/dds/queue/ProducerMember.java b/docs/modules/ROOT/examples/dds/queue/ProducerMember.java
@@ -7,9 +7,9 @@ public class ProducerMember {
 
     public static void main( String[] args ) throws Exception {
         HazelcastInstance hz = Hazelcast.newHazelcastInstance();
-        IQueue<Integer> queue = hz.getQueue( "queue" ); <1>
+        IQueue<Integer> queue = hz.getQueue( "queue" ); // <1>
 
-        <2>
+        // <2>
         for ( int k = 1; k < 100; k++ ) {
             queue.put( k );
             System.out.println( "Producing: " + k );
@@ -19,4 +19,4 @@ public static void main( String[] args ) throws Exception {
         System.out.println( "Producer Finished!" );
     }
 }
-//end::producer[]
+//end::producer[]
diff --git a/docs/modules/ROOT/examples/dds/queue/TheQueueStore.java b/docs/modules/ROOT/examples/dds/queue/TheQueueStore.java
@@ -28,7 +28,7 @@ public void deleteAll(Collection<Long> keys) {
     }
 
     @Override
-    <1>
+    // <1>
     public Item load(Long key) {
         System.out.println("load");
         return null;
@@ -46,4 +46,4 @@ public Set<Long> loadAllKeys() {
         return null;
     }
 }
-//end::qs[]
+//end::qs[]
diff --git a/docs/modules/ROOT/examples/distributedcomputing/ScheduledExecutorConfiguration.java b/docs/modules/ROOT/examples/distributedcomputing/ScheduledExecutorConfiguration.java
@@ -1,7 +1,9 @@
 import com.hazelcast.config.Config;
+import com.hazelcast.config.MergePolicyConfig;
 import com.hazelcast.core.Hazelcast;
 import com.hazelcast.core.HazelcastInstance;
 import com.hazelcast.scheduledexecutor.IScheduledExecutorService;
+import com.hazelcast.config.ScheduledExecutorConfig;
 
 public class ScheduledExecutorConfiguration {
     public static void main(String[] args) throws Exception{

diff --git a/docs/modules/ROOT/examples/distributedevents/ExampleEntryListener.java b/docs/modules/ROOT/examples/distributedevents/ExampleEntryListener.java
@@ -16,5 +16,17 @@ public void entryUpdated(EntryEvent<String, String> event) {
     public void mapCleared(MapEvent event) {
         System.out.println( "Map Cleared: " + event );
     }
+    @Override
+    public void entryRemoved(EntryEvent<String, String> event) {
+    }
+    @Override
+    public void entryEvicted(EntryEvent<String, String> event) {
+    }
+    @Override
+    public void entryExpired(EntryEvent<String, String> event) {
+    }
+    @Override
+    public void mapEvicted(MapEvent event) {
+    }
 }
-//end::mm[]
+//end::mm[]
diff --git a/docs/modules/ROOT/examples/distributedevents/Listen.java b/docs/modules/ROOT/examples/distributedevents/Listen.java
@@ -1,6 +1,6 @@
 import com.hazelcast.core.Hazelcast;
 import com.hazelcast.core.HazelcastInstance;
-import com.hazelcast.core.HazelcastClient;
+import com.hazelcast.client.HazelcastClient;
 import com.hazelcast.map.IMap;
 import com.hazelcast.map.MapEvent;
 import com.hazelcast.core.EntryEvent;
@@ -10,7 +10,7 @@
 public class Listen {
 
     public static void main( String[] args ) {
-        HazelcastInstance hz = HazelcastClient.newHazelcastCllient();
+        HazelcastInstance hz = HazelcastClient.newHazelcastClient();
         IMap<String, String> map = hz.getMap( "somemap" );
         map.addEntryListener( new MyEntryListener(), true );
         System.out.println( "EntryListener registered" );
@@ -60,4 +60,4 @@ public void mapCleared( MapEvent event ) {
         }
     }
 }
-//end::listen[]
+//end::listen[]
diff --git a/docs/modules/ROOT/examples/jcache/ExampleJCacheApplication.java b/docs/modules/ROOT/examples/jcache/ExampleJCacheApplication.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.Cache;
 import javax.cache.CacheManager;
 import javax.cache.Caching;
@@ -37,4 +39,4 @@ public static void main(String[] args){
         System.out.println( value );
         //end::jcacheapp[]
     }
-}
+}
diff --git a/docs/modules/ROOT/examples/jcache/PartitionLostListenerUsage.java b/docs/modules/ROOT/examples/jcache/PartitionLostListenerUsage.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import com.hazelcast.cache.ICache;
 import com.hazelcast.cache.impl.event.CachePartitionLostEvent;
 import com.hazelcast.cache.impl.event.CachePartitionLostListener;
@@ -34,4 +36,4 @@ public void partitionLost(CachePartitionLostEvent event) {
         });
     }
 }
-//end::pllu[]
+//end::pllu[]
diff --git a/docs/modules/ROOT/examples/jcache/User.java b/docs/modules/ROOT/examples/jcache/User.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import java.io.Serializable;
 
 @SuppressWarnings("unused")
@@ -66,4 +68,4 @@ public String toString() {
                 + ", username='" + username + '\''
                 + '}';
     }
-}
+}
diff --git a/docs/modules/ROOT/examples/jcache/UserCacheEntryListener.java b/docs/modules/ROOT/examples/jcache/UserCacheEntryListener.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.event.CacheEntryCreatedListener;
 import javax.cache.event.CacheEntryEvent;
 import javax.cache.event.CacheEntryExpiredListener;
@@ -45,4 +47,4 @@ private void printEvents(Iterable<CacheEntryEvent<? extends Integer, ? extends U
         }
     }
 }
-//end::ucel[]
+//end::ucel[]
diff --git a/docs/modules/ROOT/examples/jcache/UserCacheEntryListenerFactory.java b/docs/modules/ROOT/examples/jcache/UserCacheEntryListenerFactory.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.configuration.Factory;
 import javax.cache.event.CacheEntryListener;
 
@@ -10,4 +12,4 @@ public CacheEntryListener<Integer, User> create() {
         return new UserCacheEntryListener();
     }
 }
-//end::ucelf[]
+//end::ucelf[]
diff --git a/docs/modules/ROOT/examples/jcache/UserCacheLoader.java b/docs/modules/ROOT/examples/jcache/UserCacheLoader.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.integration.CacheLoader;
 import javax.cache.integration.CacheLoaderException;
 import java.io.Serializable;
@@ -36,4 +38,4 @@ public Map<Integer, User> loadAll(Iterable<? extends Integer> keys) throws Cache
         return loaded;
     }
 }
-//end::ucl[]
+//end::ucl[]
diff --git a/docs/modules/ROOT/examples/jcache/UserCacheWriter.java b/docs/modules/ROOT/examples/jcache/UserCacheWriter.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.Cache;
 import javax.cache.integration.CacheWriter;
 import javax.cache.integration.CacheWriterException;
@@ -55,4 +57,4 @@ public void deleteAll(Collection<?> keys) throws CacheWriterException {
         }
     }
 }
-//end::ucw[]
+//end::ucw[]
diff --git a/docs/modules/ROOT/examples/jcache/UserDao.java b/docs/modules/ROOT/examples/jcache/UserDao.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import java.util.Collection;
 
 //tag::userdao[]
@@ -8,4 +10,4 @@ public interface UserDao {
     boolean removeUser(int userId);
     Collection<Integer> allUserIds();
 }
-//end::userdao[]
+//end::userdao[]
diff --git a/docs/modules/ROOT/examples/jcache/UserUpdateEntryProcessor.java b/docs/modules/ROOT/examples/jcache/UserUpdateEntryProcessor.java
@@ -1,3 +1,5 @@
+package jcache;
+
 import javax.cache.processor.EntryProcessor;
 import javax.cache.processor.EntryProcessorException;
 import javax.cache.processor.MutableEntry;
@@ -34,4 +36,4 @@ public User process(MutableEntry<Integer, User> entry, Object... arguments) thro
         return user;
     }
 }
-//end::uuep[]
+//end::uuep[]
diff --git a/docs/modules/ROOT/examples/security/CredentialsCallback.java b/docs/modules/ROOT/examples/security/CredentialsCallback.java
@@ -1,3 +1,5 @@
+package security;
+
 import com.hazelcast.security.Credentials;
 
 import javax.security.auth.callback.Callback;

diff --git a/docs/modules/ROOT/examples/security/CustomLoginModule.java b/docs/modules/ROOT/examples/security/CustomLoginModule.java
@@ -1,3 +1,5 @@
+package security;
+
 import com.hazelcast.security.Credentials;
 
 import javax.security.auth.Subject;

diff --git a/.../ROOT/examples/CustomLoginModuleTest.java → ...mples/security/CustomLoginModuleTest.java b/.../ROOT/examples/CustomLoginModuleTest.java → ...mples/security/CustomLoginModuleTest.java