diff --git a/processors/http-utils-kt/.gitignore b/processors/http-utils-kt/.gitignore new file mode 100644 index 0000000..7f097a4 --- /dev/null +++ b/processors/http-utils-kt/.gitignore @@ -0,0 +1,44 @@ +.kotlin + +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store diff --git a/processors/http-utils-kt/build.gradle.kts b/processors/http-utils-kt/build.gradle.kts new file mode 100644 index 0000000..aac9dc9 --- /dev/null +++ b/processors/http-utils-kt/build.gradle.kts @@ -0,0 +1,36 @@ +plugins { + `java-library` + kotlin("jvm") version "2.0.0" +} + +group = "technology.idlab.http-utils-kt" + +version = "1.0-SNAPSHOT" + +/** Set the Kotlin JVM version to 17. */ +kotlin { jvmToolchain(17) } + +repositories { mavenCentral() } + +dependencies { + implementation("org.reflections:reflections:0.10.2") + + // Processor class and other utilities. + implementation(files("../../build/libs/technology.idlab.jvm-runner-0.0.4-all.jar")) + + // RDF dependencies. + implementation("org.apache.jena:apache-jena-libs:5.0.0") + implementation("org.apache.jena:jena-arq:5.0.0") + implementation("org.apache.jena:jena-shacl:5.0.0") + + // Initialize testing. + testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0") + testImplementation("org.jetbrains.kotlin:kotlin-test") +} + +/** Use JUnit for testing. */ +tasks.test { + useJUnitPlatform() + + testLogging { showStandardStreams = true } +} diff --git a/processors/http-utils-kt/gradle.properties b/processors/http-utils-kt/gradle.properties new file mode 100644 index 0000000..7fc6f1f --- /dev/null +++ b/processors/http-utils-kt/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official diff --git a/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.jar b/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.jar differ diff --git a/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.properties b/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..5dcbe03 --- /dev/null +++ b/processors/http-utils-kt/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sat Jul 20 17:06:30 CEST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/processors/http-utils-kt/gradlew b/processors/http-utils-kt/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/processors/http-utils-kt/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${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" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# 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 ;; #( + MSYS* | 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" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/processors/http-utils-kt/gradlew.bat b/processors/http-utils-kt/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/processors/http-utils-kt/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/processors/http-utils-kt/index.ttl b/processors/http-utils-kt/index.ttl new file mode 100644 index 0000000..9981b66 --- /dev/null +++ b/processors/http-utils-kt/index.ttl @@ -0,0 +1,60 @@ +@prefix rdf: . +@prefix rdfc: . +@prefix sh: . +@prefix xsd: . + +[] + a rdfc:Package ; + rdfc:version "0.0.1" ; + rdfc:author "Jens Pots" ; + rdfc:description "HTTP utilities, written in Kotlin." ; + rdfc:repo "https://github.com/rdf-connect/orchestrator.git" ; + rdfc:license "MIT" ; + rdfc:prepare ( + "./gradlew jar" + ) ; + rdfc:processors rdfc:HttpFetchKT . + +rdfc:HttpFetchKT + a rdfc:Processor ; + rdfc:target rdfc:JVMRunner ; + rdfc:entrypoint <./build/libs/http-utils-kt-1.0-SNAPSHOT.jar> ; + rdfc:metadata "class: technology.idlab.httputils.HttpFetch" . + +[] + a sh:NodeShape ; + sh:closed true ; + sh:ignoredProperties ( rdf:type ) ; + sh:targetClass rdfc:HttpFetchKT ; + sh:property [ + sh:maxCount 1 ; + sh:minCount 1 ; + sh:name "arguments" ; + sh:path rdfc:arguments ; + sh:node [ + sh:property [ + sh:maxCount 1 ; + sh:minCount 0 ; + sh:name "method" ; + sh:path rdfc:method ; + sh:datatype xsd:string ; + ], [ + sh:maxCount 1 ; + sh:minCount 1 ; + sh:name "outgoing" ; + sh:path rdfc:outgoing ; + sh:class rdfc:Writer ; + ], [ + sh:maxCount 1 ; + sh:minCount 1 ; + sh:name "endpoint" ; + sh:path rdfc:endpoint ; + sh:nodeKind sh:IRIOrLiteral ; + ], [ + sh:minCount 0 ; + sh:name "headers" ; + sh:path rdfc:headers ; + sh:datatype xsd:string ; + ] ; + ] ; + ]. diff --git a/processors/http-utils-kt/settings.gradle.kts b/processors/http-utils-kt/settings.gradle.kts new file mode 100644 index 0000000..9faf13f --- /dev/null +++ b/processors/http-utils-kt/settings.gradle.kts @@ -0,0 +1,3 @@ +plugins { id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" } + +rootProject.name = "http-utils-kt" diff --git a/src/main/kotlin/std/HttpFetch.kt b/processors/http-utils-kt/src/main/kotlin/HttpFetch.kt similarity index 74% rename from src/main/kotlin/std/HttpFetch.kt rename to processors/http-utils-kt/src/main/kotlin/HttpFetch.kt index 4e12da6..401cb9f 100644 --- a/src/main/kotlin/std/HttpFetch.kt +++ b/processors/http-utils-kt/src/main/kotlin/HttpFetch.kt @@ -1,4 +1,4 @@ -package technology.idlab.std +package technology.idlab.httputils import io.ktor.client.* import io.ktor.client.engine.* @@ -14,11 +14,14 @@ class HttpFetch(args: Arguments) : Processor(args) { /** Meta configuration. */ private var engine: HttpClientEngine = CIO.create() + /** Default values. */ + private val methodDefault = "GET" + /** Parameters. */ - private val endpoint: String = arguments["endpoint"] - private val output: SendChannel = arguments["output"] - private val headers: Array = arguments["headers"] - private val method: String = arguments.get("method") ?: "GET" + private val endpoint: String by args + private val outgoing: SendChannel by args + private val headers: Array? by args + private val method: String? by args /** Prebuild request. */ private val builder = HttpRequestBuilder() @@ -26,8 +29,8 @@ class HttpFetch(args: Arguments) : Processor(args) { /** Build the HTTP request. */ init { builder.url(endpoint) - builder.method = HttpMethod.parse(method) - headers.map { header -> + builder.method = HttpMethod.parse(method ?: methodDefault) + headers?.map { header -> val (key, value) = header.split(":").map { it.trim() } builder.headers.append(key, value) } @@ -45,7 +48,8 @@ class HttpFetch(args: Arguments) : Processor(args) { // Push the result to the output. val bytes = res.readBytes() - output.send(bytes) + outgoing.send(bytes) + outgoing.close() } internal fun overwriteEngine(engine: HttpClientEngine) { diff --git a/processors/http-utils-kt/src/main/resources/.keep b/processors/http-utils-kt/src/main/resources/.keep new file mode 100644 index 0000000..e69de29 diff --git a/processors/http-utils-kt/src/test/kotlin/.keep b/processors/http-utils-kt/src/test/kotlin/.keep new file mode 100644 index 0000000..e69de29 diff --git a/processors/http-utils-kt/src/test/resources/.keep b/processors/http-utils-kt/src/test/resources/.keep new file mode 100644 index 0000000..e69de29 diff --git a/src/main/kotlin/std/README.md b/src/main/kotlin/std/README.md deleted file mode 100644 index eecd8fc..0000000 --- a/src/main/kotlin/std/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Standard Processor Library - -This directory contains implementations of processors which can be used directly by the end user, without the need for additional dependencies. These also exist as a reference to processor developers. - -Their RDF definitions can be found [here](./../../resources/std). These are included in the default ontology. diff --git a/src/main/kotlin/std/Transparent.kt b/src/main/kotlin/std/Transparent.kt deleted file mode 100644 index 6e657a3..0000000 --- a/src/main/kotlin/std/Transparent.kt +++ /dev/null @@ -1,22 +0,0 @@ -package technology.idlab.std - -import kotlinx.coroutines.channels.ReceiveChannel -import kotlinx.coroutines.channels.SendChannel -import technology.idlab.runner.impl.jvm.Arguments -import technology.idlab.runner.impl.jvm.Processor -import technology.idlab.util.Log - -class Transparent(args: Arguments) : Processor(args) { - private val input: ReceiveChannel = arguments["input"] - private val output: SendChannel = arguments["output"] - - override suspend fun exec() { - Log.shared.debug { "Transparent processor started" } - for (data in input) { - Log.shared.debug { "Received ${data.size} bytes" } - output.send(data) - } - output.close() - Log.shared.debug { "Transparent processor finished" } - } -} diff --git a/src/test/kotlin/e2e/E2ETest.kt b/src/test/kotlin/e2e/E2ETest.kt index 3b20069..a1ac27c 100644 --- a/src/test/kotlin/e2e/E2ETest.kt +++ b/src/test/kotlin/e2e/E2ETest.kt @@ -50,6 +50,13 @@ class E2ETest { @Test fun jvm() { + // Remove the web page if it already exists. + val webPage = File("/tmp/rdfc-testing/web.html") + webPage.delete() + run("/e2e/jvm.ttl") + + // Check if web page has been fetched and written to disk. + assert(webPage.readText().contains("Example Domain")) } } diff --git a/src/test/resources/e2e/jvm.ttl b/src/test/resources/e2e/jvm.ttl index d48ff35..05ce448 100644 --- a/src/test/resources/e2e/jvm.ttl +++ b/src/test/resources/e2e/jvm.ttl @@ -9,6 +9,7 @@ test:report a rdfc:Channel . test:validated a rdfc:Channel . test:unvalidated a rdfc:Channel . +test:web a rdfc:Channel . test:JVMTestingPipeline a rdfc:Pipeline ; @@ -18,11 +19,22 @@ test:JVMTestingPipeline test:FileReader , test:SHACLValidator , test:FileWriter , - test:ReportWriter ; + test:ReportWriter , + test:HttpFetch , + test:HttpWriter ; rdfc:dependency + <../../../../processors/http-utils-kt> , <../../../../processors/file-utils-kt> , <../../../../processors/shacl-validator-kt> . +test:HttpFetch + a rdfc:HttpFetchKT ; + rdfc:arguments [ + rdfc:endpoint "https://example.com" ; + rdfc:method "GET" ; + rdfc:outgoing test:web ; + ] . + test:FileReader a rdfc:FileReaderKT ; rdfc:arguments [ @@ -43,6 +55,13 @@ test:SHACLValidator rdfc:fatal "false"^^xsd:boolean ; ] . +test:HttpWriter + a rdfc:FileWriterKT ; + rdfc:arguments [ + rdfc:path ; + rdfc:incoming test:web ; + ] . + test:FileWriter a rdfc:FileWriterKT ; rdfc:arguments [