diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 00000000..41cfd063 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,47 @@ +name: CI + +on: + push: + branches: + - master + - "[0-9]+" + - "[0-9]+.[0-9]+" + workflow_dispatch: + pull_request: + +jobs: + check-generic-contracts-and-functions: + name: Gradle check for generic contracts and functions + runs-on: ubuntu-latest + + defaults: + run: + working-directory: generic-contracts-and-functions + + steps: + - uses: actions/checkout@v4 + + - name: Set up JDK 1.8 + uses: actions/setup-java@v4 + with: + distribution: 'temurin' + java-version: '8' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v3 + + - name: Check with Gradle + run: ./gradlew check + + - name: Package artifacts + if: always() + run: | + mkdir -p /tmp/artifacts-generic-contracts-and-functions + cp -a build/reports/tests/test /tmp/artifacts-generic-contracts-and-functions/ + cp -a build/reports/spotbugs /tmp/artifacts-generic-contracts-and-functions/ + + - uses: actions/upload-artifact@v4 + if: always() + with: + name: artifacts-generic-contracts-and-functions + path: /tmp/artifacts-generic-contracts-and-functions diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..ca228215 --- /dev/null +++ b/.gitignore @@ -0,0 +1,84 @@ +############################## +## Java +############################## +.mtj.tmp/ +*.class +*.jar +*.war +*.ear +*.nar +hs_err_pid* + +############################## +## Maven +############################## +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +pom.xml.bak +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties +.mvn/wrapper/maven-wrapper.jar + +############################## +## Gradle +############################## +bin/ +build/ +.gradle +.gradletasknamecache +gradle-app.setting +!gradle-wrapper.jar + +############################## +## IntelliJ +############################## +out/ +.idea/ +.idea_modules/ +*.iml +*.ipr +*.iws + +############################## +## Eclipse +############################## +.settings/ +bin/ +tmp/ +.metadata +.classpath +.project +*.tmp +*.bak +*.swp +*~.nib +local.properties +.loadpath +.factorypath + +############################## +## NetBeans +############################## +nbproject/private/ +build/ +nbbuild/ +dist/ +nbdist/ +nbactions.xml +nb-configuration.xml + +############################## +## Visual Studio Code +############################## +.vscode/ +.code-workspace + +############################## +## OS X +############################## +.DS_Store diff --git a/generic-contracts-and-functions/build.gradle b/generic-contracts-and-functions/build.gradle new file mode 100644 index 00000000..79ea8d74 --- /dev/null +++ b/generic-contracts-and-functions/build.gradle @@ -0,0 +1,80 @@ +plugins { + id 'com.diffplug.spotless' version '6.13.0' + id 'com.github.spotbugs' version '5.2.5' + id 'net.ltgt.errorprone' version '3.1.0' +} + +apply plugin: 'java' +apply plugin: 'idea' +apply plugin: 'com.diffplug.spotless' + +ext { + scalarDlVersion = '3.9.0' + scalarDbVersion = '3.13.0' + junitVersion = '5.10.3' + junitPlatformVersion = '1.10.3' + mockitoVersion = '4.11.0' + assertjVersion = '3.26.0' + errorproneVersion = '2.10.0' + errorproneJavacVersion = '9+181-r4173-1' + spotbugsVersion = '4.8.6' +} + +repositories { + mavenCentral() +} + +dependencies { + implementation group: 'com.scalar-labs', name: 'scalardl-java-client-sdk', version: "${scalarDlVersion}" + implementation group: 'com.scalar-labs', name: 'scalardb', version: "${scalarDbVersion}" + testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: "${junitVersion}" + testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: "${junitVersion}" + testImplementation group: 'org.junit.platform', name: 'junit-platform-console', version: "${junitPlatformVersion}" + testImplementation group: 'org.assertj', name: 'assertj-core', version: "${assertjVersion}" + testImplementation group: 'org.mockito', name: 'mockito-core', version: "${mockitoVersion}" + testImplementation group: 'org.mockito', name: 'mockito-inline', version: "${mockitoVersion}" + + // for Error Prone + errorprone "com.google.errorprone:error_prone_core:${errorproneVersion}" + errorproneJavac "com.google.errorprone:javac:${errorproneJavacVersion}" + + // for SpotBugs + spotbugs "com.github.spotbugs:spotbugs:${spotbugsVersion}" + compileOnly "com.github.spotbugs:spotbugs-annotations:${spotbugsVersion}" + testCompileOnly "com.github.spotbugs:spotbugs-annotations:${spotbugsVersion}" +} + +test { + useJUnitPlatform() +} + +spotless { + java { + target 'src/*/java/**/*.java' + importOrder() + removeUnusedImports() + googleJavaFormat('1.7') + } +} + +spotbugs { + ignoreFailures = false + showStackTraces = true + showProgress = true + effort = 'default' + reportLevel = 'default' + maxHeapSize = '1g' + extraArgs = [ '-nested:false' ] + jvmArgs = [ '-Duser.language=en' ] +} + +spotbugsMain.reports { + html.enabled = true +} + +spotbugsTest.reports { + html.enabled = true +} + +sourceCompatibility = 1.8 +targetCompatibility = 1.8 diff --git a/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.jar b/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..e6441136 Binary files /dev/null and b/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.jar differ diff --git a/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.properties b/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..a4413138 --- /dev/null +++ b/generic-contracts-and-functions/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/generic-contracts-and-functions/gradlew b/generic-contracts-and-functions/gradlew new file mode 100755 index 00000000..b740cf13 --- /dev/null +++ b/generic-contracts-and-functions/gradlew @@ -0,0 +1,249 @@ +#!/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/HEAD/platforms/jvm/plugins-application/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 + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# 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 + if ! command -v java >/dev/null 2>&1 + then + 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 +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + 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 + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# 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/generic-contracts-and-functions/gradlew.bat b/generic-contracts-and-functions/gradlew.bat new file mode 100644 index 00000000..7101f8e4 --- /dev/null +++ b/generic-contracts-and-functions/gradlew.bat @@ -0,0 +1,92 @@ +@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=. +@rem This is normally unused +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% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +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% equ 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! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/Constants.java b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/Constants.java new file mode 100644 index 00000000..7bd2b80d --- /dev/null +++ b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/Constants.java @@ -0,0 +1,26 @@ +package com.scalar.dl.client; + +public class Constants { + + public static final String OBJECT_ID = "object_id"; + public static final String HASH_VALUE = "hash_value"; + public static final String HASH_VALUES = "hash_values"; + public static final String PROPERTIES = "properties"; + public static final String STATUS = "status"; + public static final String FAULTY_VERSIONS = "faulty_versions"; + + public static final String STATUS_NORMAL = "normal"; + public static final String STATUS_FAULTY = "faulty"; + + // Error messages + public static final String OBJECT_ID_IS_MISSING_OR_INVALID = + "The object ID is not specified in the arguments or invalid."; + public static final String HASH_VALUE_IS_MISSING_OR_INVALID = + "The hash value is not specified in the arguments or invalid."; + public static final String HASH_VALUES_ARE_MISSING = + "The hash values are not specified in the arguments."; + public static final String INVALID_PROPERTIES_FORMAT = + "The specified format of the properties is not valid."; + public static final String INVALID_HASH_VALUES_FORMAT = + "The specified format of the hash values is not valid."; +} diff --git a/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/GetObject.java b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/GetObject.java new file mode 100644 index 00000000..bc5db484 --- /dev/null +++ b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/GetObject.java @@ -0,0 +1,28 @@ +package com.scalar.dl.client.contract; + +import com.fasterxml.jackson.databind.JsonNode; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.contract.JacksonBasedContract; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Asset; +import com.scalar.dl.ledger.statemachine.Ledger; +import java.util.Optional; +import javax.annotation.Nullable; + +public class GetObject extends JacksonBasedContract { + + @Nullable + @Override + public JsonNode invoke( + Ledger ledger, JsonNode arguments, @Nullable JsonNode properties) { + + if (!arguments.has(Constants.OBJECT_ID) || !arguments.get(Constants.OBJECT_ID).isTextual()) { + throw new ContractContextException(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + } + + String assetId = arguments.get(Constants.OBJECT_ID).asText(); + Optional> asset = ledger.get(assetId); + + return asset.map(Asset::data).orElse(null); + } +} diff --git a/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/PutObject.java b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/PutObject.java new file mode 100644 index 00000000..86714edd --- /dev/null +++ b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/PutObject.java @@ -0,0 +1,46 @@ +package com.scalar.dl.client.contract; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.contract.JacksonBasedContract; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Ledger; +import javax.annotation.Nullable; + +public class PutObject extends JacksonBasedContract { + + @Nullable + @Override + public JsonNode invoke( + Ledger ledger, JsonNode arguments, @Nullable JsonNode properties) { + + if (!arguments.has(Constants.OBJECT_ID) || !arguments.get(Constants.OBJECT_ID).isTextual()) { + throw new ContractContextException(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + } + + if (!arguments.has(Constants.HASH_VALUE) || !arguments.get(Constants.HASH_VALUE).isTextual()) { + throw new ContractContextException(Constants.HASH_VALUE_IS_MISSING_OR_INVALID); + } + + if (arguments.has(Constants.PROPERTIES) && !arguments.get(Constants.PROPERTIES).isObject()) { + throw new ContractContextException(Constants.INVALID_PROPERTIES_FORMAT); + } + + String assetId = arguments.get(Constants.OBJECT_ID).asText(); + ObjectNode node = + getObjectMapper() + .createObjectNode() + .put(Constants.OBJECT_ID, arguments.get(Constants.OBJECT_ID).asText()) + .put(Constants.HASH_VALUE, arguments.get(Constants.HASH_VALUE).asText()); + + if (arguments.has(Constants.PROPERTIES)) { + node.set(Constants.PROPERTIES, arguments.get(Constants.PROPERTIES)); + } + + ledger.get(assetId); + ledger.put(assetId, node); + + return null; + } +} diff --git a/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/ValidateObject.java b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/ValidateObject.java new file mode 100644 index 00000000..f4c0db9e --- /dev/null +++ b/generic-contracts-and-functions/src/main/java/com/scalar/dl/client/contract/ValidateObject.java @@ -0,0 +1,93 @@ +package com.scalar.dl.client.contract; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.contract.JacksonBasedContract; +import com.scalar.dl.ledger.database.AssetFilter; +import com.scalar.dl.ledger.database.AssetFilter.AgeOrder; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Asset; +import com.scalar.dl.ledger.statemachine.Ledger; +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.stream.IntStream; +import javax.annotation.Nullable; + +public class ValidateObject extends JacksonBasedContract { + + @Nullable + @Override + public JsonNode invoke( + Ledger ledger, JsonNode arguments, @Nullable JsonNode properties) { + + if (!arguments.has(Constants.OBJECT_ID) || !arguments.get(Constants.OBJECT_ID).isTextual()) { + throw new ContractContextException(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + } + + if (!arguments.has(Constants.HASH_VALUES)) { + throw new ContractContextException(Constants.HASH_VALUES_ARE_MISSING); + } + + List> hashValues = + validateAndGetHashValues(arguments.get(Constants.HASH_VALUES)); + + String assetId = arguments.get(Constants.OBJECT_ID).asText(); + AssetFilter filter = + new AssetFilter(assetId).withLimit(hashValues.size()).withAgeOrder(AgeOrder.DESC); + + List> history = ledger.scan(filter); + + List faultyVersions = new ArrayList<>(); + IntStream.range(0, history.size()) + .forEach( + i -> { + Asset asset = history.get(i); + if (!asset.data().has(Constants.HASH_VALUE) + || !asset + .data() + .get(Constants.HASH_VALUE) + .asText() + .equals(hashValues.get(i).getValue())) { + faultyVersions.add(hashValues.get(i).getKey()); + } + }); + + String status = + history.size() == hashValues.size() && faultyVersions.isEmpty() + ? Constants.STATUS_NORMAL + : Constants.STATUS_FAULTY; + ArrayNode jsonFaultyVersions = getObjectMapper().createArrayNode(); + faultyVersions.forEach(jsonFaultyVersions::add); + + return getObjectMapper() + .createObjectNode() + .put(Constants.STATUS, status) + .set(Constants.FAULTY_VERSIONS, jsonFaultyVersions); + } + + private List> validateAndGetHashValues(JsonNode hashValues) { + if (!hashValues.isArray() || hashValues.isEmpty()) { + throw new ContractContextException(Constants.INVALID_HASH_VALUES_FORMAT); + } + + List> results = new ArrayList<>(); + for (JsonNode hashValue : hashValues) { + if (!hashValue.isObject() || hashValue.size() != 1) { + throw new ContractContextException(Constants.INVALID_HASH_VALUES_FORMAT); + } + + Entry entry = hashValue.fields().next(); + if (!entry.getValue().isTextual()) { + throw new ContractContextException(Constants.INVALID_HASH_VALUES_FORMAT); + } + + results.add(new AbstractMap.SimpleEntry<>(entry.getKey(), entry.getValue().asText())); + } + + return results; + } +} diff --git a/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/GetObjectTest.java b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/GetObjectTest.java new file mode 100644 index 00000000..4b3bf9ec --- /dev/null +++ b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/GetObjectTest.java @@ -0,0 +1,84 @@ +package com.scalar.dl.client.contract; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Asset; +import com.scalar.dl.ledger.statemachine.Ledger; +import java.util.Optional; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; + +public class GetObjectTest { + + private static final ObjectMapper mapper = new ObjectMapper(); + private static final String SOME_OBJECT_ID = "foo"; + private static final String SOME_HASH_VALUE = "bar"; + private static final JsonNode SOME_PROPERTIES = mapper.createObjectNode().put("x", 1); + private static final JsonNode SOME_DATA = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE) + .set(Constants.PROPERTIES, SOME_PROPERTIES); + + private final GetObject getObject = new GetObject(); + + @Mock private Ledger ledger; + + @BeforeEach + public void setUp() throws Exception { + MockitoAnnotations.openMocks(this).close(); + } + + @Test + public void invoke_CorrectArgumentsGiven_ShouldGetObject() { + // Arrange + JsonNode argument = mapper.createObjectNode().put(Constants.OBJECT_ID, SOME_OBJECT_ID); + Asset asset = (Asset) mock(Asset.class); + Optional> expected = Optional.of(asset); + when(ledger.get(SOME_OBJECT_ID)).thenReturn(expected); + when(asset.data()).thenReturn(SOME_DATA); + + // Act + JsonNode actual = getObject.invoke(ledger, argument, null); + + // Assert + assertThat(actual).isEqualTo(SOME_DATA); + verify(ledger).get(SOME_OBJECT_ID); + } + + @Test + public void invoke_ArgumentsWithoutObjectIdGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = mapper.createObjectNode(); + + // Act Assert + assertThatThrownBy(() -> getObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + verify(ledger, never()).get(SOME_OBJECT_ID); + } + + @Test + public void invoke_ArgumentsWithInvalidObjectIdTypeGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = mapper.createObjectNode().put(Constants.OBJECT_ID, 1); + + // Act Assert + assertThatThrownBy(() -> getObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + verify(ledger, never()).get(SOME_OBJECT_ID); + } +} diff --git a/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/PutObjectTest.java b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/PutObjectTest.java new file mode 100644 index 00000000..038122ec --- /dev/null +++ b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/PutObjectTest.java @@ -0,0 +1,113 @@ +package com.scalar.dl.client.contract; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Ledger; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; + +public class PutObjectTest { + + private static final ObjectMapper mapper = new ObjectMapper(); + private static final String SOME_OBJECT_ID = "foo"; + private static final String SOME_HASH_VALUE = "bar"; + private static final JsonNode SOME_PROPERTIES = mapper.createObjectNode().put("x", 1); + + private final PutObject putObject = new PutObject(); + + @Mock private Ledger ledger; + + @BeforeEach + public void setUp() throws Exception { + MockitoAnnotations.openMocks(this).close(); + } + + @Test + public void invoke_CorrectArgumentsGiven_ShouldPutObject() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE) + .set(Constants.PROPERTIES, SOME_PROPERTIES); + + // Act + JsonNode actual = putObject.invoke(ledger, argument, null); + + // Assert + assertThat(actual).isNull(); + verify(ledger).get(SOME_OBJECT_ID); + verify(ledger) + .put( + SOME_OBJECT_ID, + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, argument.get(Constants.OBJECT_ID).asText()) + .put(Constants.HASH_VALUE, argument.get(Constants.HASH_VALUE).asText()) + .set(Constants.PROPERTIES, argument.get(Constants.PROPERTIES))); + } + + @Test + public void invoke_ArgumentsWithoutObjectIdGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.HASH_VALUE, SOME_HASH_VALUE) + .set(Constants.PROPERTIES, SOME_PROPERTIES); + + // Act Assert + assertThatThrownBy(() -> putObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + verify(ledger, never()).get(SOME_OBJECT_ID); + verify(ledger, never()).put(eq(SOME_OBJECT_ID), any(JsonNode.class)); + } + + @Test + public void invoke_ArgumentsWithoutHashValueGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set(Constants.PROPERTIES, SOME_PROPERTIES); + + // Act Assert + assertThatThrownBy(() -> putObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.HASH_VALUE_IS_MISSING_OR_INVALID); + verify(ledger, never()).get(SOME_OBJECT_ID); + verify(ledger, never()).put(eq(SOME_OBJECT_ID), any(JsonNode.class)); + } + + @Test + public void invoke_ArgumentsWithInvalidPropertiesGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE) + .put(Constants.PROPERTIES, "bar"); + + // Act Assert + assertThatThrownBy(() -> putObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.INVALID_PROPERTIES_FORMAT); + verify(ledger, never()).get(SOME_OBJECT_ID); + verify(ledger, never()).put(eq(SOME_OBJECT_ID), any(JsonNode.class)); + } +} diff --git a/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/ValidateObjectTest.java b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/ValidateObjectTest.java new file mode 100644 index 00000000..aa0720b1 --- /dev/null +++ b/generic-contracts-and-functions/src/test/java/com/scalar/dl/client/contract/ValidateObjectTest.java @@ -0,0 +1,240 @@ +package com.scalar.dl.client.contract; + +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.common.collect.ImmutableList; +import com.scalar.dl.client.Constants; +import com.scalar.dl.ledger.database.AssetFilter; +import com.scalar.dl.ledger.database.AssetFilter.AgeOrder; +import com.scalar.dl.ledger.exception.ContractContextException; +import com.scalar.dl.ledger.statemachine.Asset; +import com.scalar.dl.ledger.statemachine.Ledger; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; + +public class ValidateObjectTest { + + private static final ObjectMapper mapper = new ObjectMapper(); + private static final String SOME_OBJECT_ID = "foo"; + private static final String SOME_VERSION_ID_0 = "v3"; + private static final String SOME_VERSION_ID_1 = "v4"; + private static final String SOME_VERSION_ID_2 = "v5"; + private static final String SOME_HASH_VALUE_0 = "bar3"; + private static final String SOME_HASH_VALUE_1 = "bar4"; + private static final String SOME_HASH_VALUE_2 = "bar5"; + + private final ValidateObject validateObject = new ValidateObject(); + + @Mock private Ledger ledger; + + @BeforeEach + public void setUp() throws Exception { + MockitoAnnotations.openMocks(this).close(); + } + + @Test + public void invoke_CorrectArgumentsGiven_ShouldReturnStatusNormal() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set( + Constants.HASH_VALUES, + mapper + .createArrayNode() + .add(mapper.createObjectNode().put(SOME_VERSION_ID_2, SOME_HASH_VALUE_2)) + .add(mapper.createObjectNode().put(SOME_VERSION_ID_1, SOME_HASH_VALUE_1)) + .add(mapper.createObjectNode().put(SOME_VERSION_ID_0, SOME_HASH_VALUE_0))); + Asset asset0 = (Asset) mock(Asset.class); + Asset asset1 = (Asset) mock(Asset.class); + Asset asset2 = (Asset) mock(Asset.class); + JsonNode data0 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_0); + JsonNode data1 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_1); + JsonNode data2 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_2); + AssetFilter filter = new AssetFilter(SOME_OBJECT_ID).withLimit(3).withAgeOrder(AgeOrder.DESC); + when(asset0.data()).thenReturn(data0); + when(asset1.data()).thenReturn(data1); + when(asset2.data()).thenReturn(data2); + when(ledger.scan(any(AssetFilter.class))).thenReturn(ImmutableList.of(asset2, asset1, asset0)); + + // Act + JsonNode actual = validateObject.invoke(ledger, argument, null); + + // Assert + assertThat(actual.get(Constants.STATUS).asText()).isEqualTo(Constants.STATUS_NORMAL); + assertThat(actual.get(Constants.FAULTY_VERSIONS).isArray()).isTrue(); + assertThat(actual.get(Constants.FAULTY_VERSIONS).size()).isEqualTo(0); + verify(ledger).scan(filter); + } + + @Test + public void invoke_TamperedArgumentsGiven_ShouldReturnStatusFaulty() { + // Arrange + JsonNode argument = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set( + Constants.HASH_VALUES, + mapper + .createArrayNode() + .add(mapper.createObjectNode().put(SOME_VERSION_ID_2, "tampered")) + .add(mapper.createObjectNode().put(SOME_VERSION_ID_1, SOME_HASH_VALUE_1)) + .add(mapper.createObjectNode().put(SOME_VERSION_ID_0, "tampered"))); + Asset asset0 = (Asset) mock(Asset.class); + Asset asset1 = (Asset) mock(Asset.class); + Asset asset2 = (Asset) mock(Asset.class); + JsonNode data0 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_0); + JsonNode data1 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_1); + JsonNode data2 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUE, SOME_HASH_VALUE_2); + AssetFilter filter = new AssetFilter(SOME_OBJECT_ID).withLimit(3).withAgeOrder(AgeOrder.DESC); + when(asset0.data()).thenReturn(data0); + when(asset1.data()).thenReturn(data1); + when(asset2.data()).thenReturn(data2); + when(ledger.scan(any(AssetFilter.class))).thenReturn(ImmutableList.of(asset2, asset1, asset0)); + + // Act + JsonNode actual = validateObject.invoke(ledger, argument, null); + + // Assert + assertThat(actual.get(Constants.STATUS).asText()).isEqualTo(Constants.STATUS_FAULTY); + assertThat(actual.get(Constants.FAULTY_VERSIONS).isArray()).isTrue(); + assertThat(actual.get(Constants.FAULTY_VERSIONS).size()).isEqualTo(2); + assertThat(actual.get(Constants.FAULTY_VERSIONS).get(0).asText()).isEqualTo(SOME_VERSION_ID_2); + assertThat(actual.get(Constants.FAULTY_VERSIONS).get(1).asText()).isEqualTo(SOME_VERSION_ID_0); + verify(ledger).scan(filter); + } + + @Test + public void invoke_ArgumentsWithoutObjectIdGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = mapper.createObjectNode(); + + // Act Assert + assertThatThrownBy(() -> validateObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + verify(ledger, never()).scan(any()); + } + + @Test + public void invoke_ArgumentsWithInvalidObjectIdTypeGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = mapper.createObjectNode().put(Constants.OBJECT_ID, 1); + + // Act Assert + Assertions.assertThatThrownBy(() -> validateObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.OBJECT_ID_IS_MISSING_OR_INVALID); + verify(ledger, never()).scan(any()); + } + + @Test + public void invoke_ArgumentsWithoutHashValuesGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument = mapper.createObjectNode().put(Constants.OBJECT_ID, SOME_OBJECT_ID); + + // Act Assert + assertThatThrownBy(() -> validateObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.HASH_VALUES_ARE_MISSING); + verify(ledger, never()).scan(any()); + } + + @Test + public void invoke_ArgumentsWithInvalidHashValuesGiven_ShouldThrowContractContextException() { + // Arrange + JsonNode argument1 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .put(Constants.HASH_VALUES, ""); + JsonNode argument2 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set( + Constants.HASH_VALUES, + mapper.createArrayNode().add("bar5").add("bar4").add("bar3")); + JsonNode argument3 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set( + Constants.HASH_VALUES, + mapper + .createArrayNode() + .add( + mapper + .createObjectNode() + .put("v5", "bar5") + .put("v4", "bar4") + .put("v3", "bar3"))); + JsonNode argument4 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set( + Constants.HASH_VALUES, + mapper + .createArrayNode() + .add(mapper.createObjectNode().put("v5", 5)) + .add(mapper.createObjectNode().put("v4", 4)) + .add(mapper.createObjectNode().put("v3", 3))); + JsonNode argument5 = + mapper + .createObjectNode() + .put(Constants.OBJECT_ID, SOME_OBJECT_ID) + .set(Constants.HASH_VALUES, mapper.createArrayNode()); + + // Act Assert + validateHashValuesAndAssert(ledger, argument1); + validateHashValuesAndAssert(ledger, argument2); + validateHashValuesAndAssert(ledger, argument3); + validateHashValuesAndAssert(ledger, argument4); + validateHashValuesAndAssert(ledger, argument5); + verify(ledger, never()).scan(any()); + } + + private void validateHashValuesAndAssert(Ledger ledger, JsonNode argument) { + Assertions.assertThatThrownBy(() -> validateObject.invoke(ledger, argument, null)) + .isExactlyInstanceOf(ContractContextException.class) + .hasMessage(Constants.INVALID_HASH_VALUES_FORMAT); + } +}