embulk-input-pubsub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cee226b5d7da880c431fdd18df237cea9ca5fec030fc9037f806cc74f174bec
+  data.tar.gz: 8f5c25a70cd36aa4a56faf3b5125015c20988474b4a7333942c403147d6969a3
+SHA512:
+  metadata.gz: 2d8439f6d0581a8c0993b4756277618ceb707d4b2809b2ff68e6351fcd2865c60dca741ebd349b86d202bbd5d671ec4411bbda12d9be7dd841e003bc22d0b762
+  data.tar.gz: 8ec794bf18c5a731d5befe75bc3f74a6d32ff03a1b5c957b8ca54a6dfb1dac8fce2d761b247531d6860ee07a5faa19b1f98c739f66874a34e6fe8441bb00d4b2

data/.gitignore

@@ -0,0 +1,2 @@
+*.class
+*.log

data/.scalafmt.conf

@@ -0,0 +1,13 @@
+version=2.3.2
+project.git = true
+project.excludeFilters = [
+  scalafmt-benchmarks/src/resources,
+  sbt-test
+  bin/issue
+]
+align = none
+# Disabled in default since this operation is potentially
+# dangerous if you define your own stripMargin with different
+# semantics from the stdlib stripMargin.
+assumeStandardLibraryStripMargin = true
+onTestFailure = "To fix this, run ./scalafmt from the project root directory"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ryo Okubo
+
+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.

data/README.md

@@ -0,0 +1,75 @@
+# embulk-input-pubsub
+
+[Google Cloud Pub/Sub](https://cloud.google.com/pubsub?hl=en) input plugin for Embulk. 
+
+## Overview
+
+* **Plugin type**: input
+* **Guess supported**: no
+
+## Configuration
+
+- **project_id**: GCP project_id (string, required)
+- **subscription_id**: Pub/Sub subscription name (string, required)
+- **json_keyfile**: A path to GCP credential json file (string, required)
+- **max_messages**: A max number of messages on once pubsub call (integer, optional)
+- **checkpoint_basedir**: A path to checkpoint dir (string, optional)
+- **checkpoint**: A path to checkpoint file (string, optional)
+
+### Checkpoint
+
+Goocle Cloud Pub/Sub removes stored messages by ack calls or expiration.
+So `embulk-input-pubsub` ensures to recovery data-loss with checkpoints which's a fashion used in Apache Flink / Apache Beam.
+It 1) pulls messages from Pub/Sub, 2) preserves a checkpoint which contains the messages and 3) ack to pubsub.
+If you got failures on Embulk tasks, you can embulk-resume with the checkpoints. And also you can do simply `embulk-run` with `checkpoint`.
+
+If you want checkpointing, you need to set `checkpoint_basedir` to preserve checkpoint files on local filesystem. if none, it uses on-memory store.
+If you want to recover state from checkpoint, you need to set `checkpoint`. It restores transaction states from given checkpoint instead of pulling message from pubsub.
+
+The checkpoint is implemented as a Protocol Buffers message.
+
+## Example
+
+- pubsub -> stdout config example
+
+```yaml 
+in:
+  type: pubsub
+  project_id: <your-project-id>
+  subscription_id: <your-subscription-name>
+  json_keyfile: /path/to/credential.json
+  max_messages: 100
+  checkpoint_basedir: /tmp/embulk-input-pubsub/
+
+out:
+  type: stdout
+```
+
+You execute the example, then you'll get the result:
+
+```
+ $ embulk run examples/pubsub2stdout.yaml
+2020-05-06 00:44:05.093 +0900: Embulk v0.9.23
+2020-05-06 00:44:06.540 +0900 [WARN] (main): DEPRECATION: JRuby org.jruby.embed.ScriptingContainer is directly injected.
+2020-05-06 00:44:10.743 +0900 [INFO] (main): Gem's home and path are set by default: "/Users/ryo/.embulk/lib/gems"
+2020-05-06 00:44:12.551 +0900 [INFO] (main): Started Embulk v0.9.23
+2020-05-06 00:44:12.858 +0900 [INFO] (0001:transaction): Loaded plugin embulk-input-pubsub (0.0.1)
+2020-05-06 00:44:18.332 +0900 [INFO] (0001:transaction): Created a new checkpoint! : /tmp/embulk-input-pubsub/checkpoint--1576110815
+2020-05-06 00:44:18.336 +0900 [INFO] (0001:transaction): Using local thread executor with max_threads=8 / output tasks 4 = input tasks 1 * 4
+2020-05-06 00:44:18.354 +0900 [INFO] (0001:transaction): {done:  0 / 1, running: 0}
+aaa,{}
+2020-05-06 00:44:18.428 +0900 [INFO] (0001:transaction): {done:  1 / 1, running: 0}
+2020-05-06 00:44:18.436 +0900 [INFO] (main): Committed.
+2020-05-06 00:44:18.436 +0900 [INFO] (main): Next config diff: {"in":{},"out":{}}
+```
+
+## Development
+
+```shell script
+$ ./gradlew gem
+```
+
+## TODO
+
+- Change it to a FileInputPlugin to be applicable for parser plugins
+- Remote filesystem based checkpointing

data/build.gradle

@@ -0,0 +1,87 @@
+plugins {
+    id 'scala'
+
+    id 'com.github.jruby-gradle.base' version '1.7.0'
+    id 'com.github.johnrengelman.shadow' version '5.2.0'
+    id 'cz.alenkacz.gradle.scalafmt' version '1.10.0'
+}
+import com.github.jrubygradle.JRubyExec
+
+configurations {
+    provided
+}
+
+// Relocate Guava packages since it's incompatible with Guava's version from Embulk
+shadowJar {
+    classifier 'shadow'
+
+    dependencies {
+        include dependency('com.google.guava:guava')
+        include dependency('com.google.guava:failureaccess')
+
+        include dependency('com.google.cloud:google-cloud-pubsub')
+        include dependency('com.google.api:api-common')
+        include dependency('com.google.api:gax')
+        include dependency('com.google.api:gax-grpc')
+        include dependency('io.grpc:grpc-api')
+        include dependency('io.grpc:grpc-core')
+        include dependency('io.grpc:grpc-netty-shaded')
+        include dependency('io.grpc:grpc-stub')
+    }
+
+    relocate 'com.google.common', 'relocated.com.google.common'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+dependencies {
+    compile 'org.scala-lang:scala-library:2.13.1'
+
+    compile 'org.embulk:embulk-core:0.9.12'
+    provided 'org.embulk:embulk-core:0.9.12'
+
+    compile 'com.google.cloud:google-cloud-pubsub:1.100.0'
+    compile 'com.google.guava:failureaccess:1.0.1'
+}
+
+task classpath(type: Copy, dependsOn: ['jar', 'shadowJar']) {
+    doFirst { file('classpath').deleteDir() }
+
+    from (configurations.runtime
+            - configurations.provided
+            + configurations.shadow
+            - files(shadowJar.getIncludedDependencies())
+            + files(shadowJar.archiveFile))
+
+    into 'classpath'
+}
+clean { delete 'classpath' }
+
+task gem(type: JRubyExec, dependsOn: ['build', 'gemspec', 'classpath']) {
+    script 'gem'
+    scriptArgs 'build', 'build/gemspec'
+    doLast { ant.move(file: "${project.name}-${project.version}.gem", todir: 'pkg') }
+}
+
+task gemspec {
+    doLast {
+        file('build').mkdirs()
+        file('build/gemspec').write($/
+Gem::Specification.new do |spec|
+    spec.name          = "${project.name}"
+    spec.version       = "${project.version}"
+    spec.authors       = ["Ryo Okubo"]
+    spec.summary       = %[Google Cloud Pub/Sub input plugin for Embulk]
+    spec.description   = %[Selects records from Cloud Pub/Sub.]
+    spec.email         = ["syucream@gmail.com"]
+    spec.licenses      = ["Apache-2.0"]
+    spec.homepage      = "https://github.com/syucream/embulk-input-pubsub"
+
+    spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+    spec.test_files    = spec.files.grep(%r"^(test|spec)/")
+    spec.require_paths = ["lib"]
+end
+/$)
+    }
+}

data/examples/pubsub2stdout.yaml

@@ -0,0 +1,10 @@
+in:
+  type: pubsub
+  project_id: <your-project-id>
+  subscription_id: <your-subscription-name>
+  json_keyfile: /path/to/credential.json
+  max_messages: 100
+  checkpoint_basedir: /tmp/embulk-input-pubsub/
+
+out:
+  type: stdout

data/gradle.properties

@@ -0,0 +1 @@
+version=0.0.1

data/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Mon Oct 21 20:40:52 JST 2019
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

data/gradlew

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"