Installation as composer dependency

steevanb · steevanb · commit 2d1050b7c5c4 · 2019-01-28T11:01:41.000+01:00
diff --git a/codeLink.sh b/codeLink.sh
@@ -1,7 +1,9 @@
 #!/usr/bin/env bash
 
-source common.sh
-source validation/configurationValidation.sh
+# Assume that we are in vendor/bin directory. If you know how to get the real path of this script, don't hesitate ;)
+readonly BENCHMARK_KIT_PATH=$(dirname $(cd `dirname $0` && pwd))"/phpbenchmarks/benchmark-kit"
+source $BENCHMARK_KIT_PATH/common.sh
+source $BENCHMARK_KIT_PATH/validation/configurationValidation.sh
 
 function isValidUrl {
     local url=$1
diff --git a/codeValidation.sh b/codeValidation.sh
@@ -1,9 +1,14 @@
 #!/usr/bin/env bash
 
+# Assume that we are in vendor/bin directory. If you know how to get the real path of this script, don't hesitate ;)
+readonly BENCHMARK_KIT_PATH=$(dirname $(cd `dirname $0` && pwd))"/phpbenchmarks/benchmark-kit"
+source $BENCHMARK_KIT_PATH/common.sh
+source $BENCHMARK_KIT_PATH/validation/configurationValidation.sh
+
 function validateCode {
     local containerName=$1
 
-    cp common.sh $RESULT_TYPE_PATH/docker/codeValidation
+    cp "$BENCHMARK_KIT_PATH/common.sh" $RESULT_TYPE_PATH/docker/codeValidation
 
     cd $RESULT_TYPE_PATH/docker/codeValidation
 
@@ -32,9 +37,6 @@ function validateCode {
     echoValidationGroupEnd
 }
 
-source common.sh
-source validation/configurationValidation.sh
-
 echoValidationGroupStart "Validation of .phpbenchmarks directory"
 copyConfigurationFiles "$CONFIGURATION_PATH"
 assertCommonConfiguration
diff --git a/common.sh b/common.sh
@@ -108,7 +108,8 @@ function definePhpComponentConfigurationValues {
     sed -i -e "s~____PHPBENCHMARKS_PHP_7_3_ENABLED____~$PHPBENCHMARKS_PHP_7_3_ENABLED~g" $phpFile
 
     sed -i -e "s~____PHPBENCHMARKS_BENCHMARK_URL____~$PHPBENCHMARKS_BENCHMARK_URL~g" $phpFile
-    sed -i -e "s~____PHPBENCHMARKS_SLUG____~$PHPBENCHMARKS_SLUG~g" $phpFile
+
+    sed -i -e "s~____PHPBENCHMARKS_COMPONENT_SLUG____~$PHPBENCHMARKS_COMPONENT_SLUG~g" $phpFile
 
     sed -i -e "s~____PHPBENCHMARKS_DEPENDENCY_NAME____~$PHPBENCHMARKS_DEPENDENCY_NAME~g" $phpFile
     sed -i -e "s~____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____~$PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION~g" $phpFile
@@ -141,7 +142,7 @@ function validateBranchName {
         echoValidationWarning "Branch names are not validated. Don't forget to remove '--repositories-not-created' parameter when repositories will be created."
     else
         local gitBranch=$(cd $INSTALLATION_PATH && git branch --no-color 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/(\1)/' -e 's/(//g' -e 's/)//g')
-        local expectedGitBranch="$PHPBENCHMARKS_SLUG"_"$PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION.$PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION"_"$RESULT_TYPE_SLUG"
+        local expectedGitBranch="$PHPBENCHMARKS_COMPONENT_SLUG"_"$PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION.$PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION"_"$RESULT_TYPE_SLUG"
         if [ $VALIDATE_DEV == true ]; then
             expectedGitBranch=$expectedGitBranch"_prepare"
         fi
@@ -177,9 +178,9 @@ function assertReadMe {
 
     local oldIFS=$IFS
     IFS=
-    local validReadMeContent=$(cat validation/mainRepository/README.md)
-    validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_SLUG____/$PHPBENCHMARKS_SLUG}
-    validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_NAME____/$PHPBENCHMARKS_NAME}
+    local validReadMeContent=$(cat $BENCHMARK_KIT_PATH/validation/mainRepository/README.md)
+    validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_COMPONENT_SLUG____/$PHPBENCHMARKS_COMPONENT_SLUG}
+    validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_COMPONENT_NAME____/$PHPBENCHMARKS_COMPONENT_NAME}
     validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____/$PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION}
     validReadMeContent=${validReadMeContent//____PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION____/$PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION}
     local readMeContent=$(cat $INSTALLATION_PATH/README.md)
diff --git a/composerUpdate.sh b/composerUpdate.sh
@@ -1,7 +1,9 @@
 #!/usr/bin/env bash
 
-source common.sh
-source validation/configurationValidation.sh
+# Assume that we are in vendor/bin directory. If you know how to get the real path of this script, don't hesitate ;)
+readonly BENCHMARK_KIT_PATH=$(dirname $(cd `dirname $0` && pwd))"/phpbenchmarks/benchmark-kit"
+source $BENCHMARK_KIT_PATH/common.sh
+source $BENCHMARK_KIT_PATH/validation/configurationValidation.sh
 
 echoValidationGroupStart "Validation of .phpbenchmarks directory"
 copyConfigurationFiles "$CONFIGURATION_PATH"
@@ -10,12 +12,12 @@ echoValidationGroupEnd
 
 validateBranchName
 
-cp common.sh docker/composerUpdate
-copyConfigurationFiles "docker/composerUpdate/componentFiles/.phpbenchmarks"
+cp "$BENCHMARK_KIT_PATH/common.sh" "$BENCHMARK_KIT_PATH/docker/composerUpdate"
+copyConfigurationFiles "$BENCHMARK_KIT_PATH/docker/composerUpdate/componentFiles/.phpbenchmarks"
 
-source docker/composerUpdate/createEnv.sh
+source "$BENCHMARK_KIT_PATH/docker/composerUpdate/createEnv.sh"
 echoValidationGroupStart "Building Docker container"
-cd docker/composerUpdate
+cd "$BENCHMARK_KIT_PATH/docker/composerUpdate"
 if [ $VERBOSE_LEVEL -ge 2 ]; then
     docker-compose up --build --no-start
     [ $? != "0" ] && exitScript "Error while building Docker container."
diff --git a/docker/benchmarkKit/cli/ComponentConfiguration.php b/docker/benchmarkKit/cli/ComponentConfiguration.php
@@ -11,9 +11,9 @@ class ComponentConfiguration
     public const PHP_7_3_ENABLED = ____PHPBENCHMARKS_PHP_7_3_ENABLED____;
 
     public const URL = "____PHPBENCHMARKS_BENCHMARK_URL____";
-    public const SLUG = "____PHPBENCHMARKS_SLUG____";
+    public const SLUG = "____PHPBENCHMARKS_COMPONENT_SLUG____";
 
-    public const COMMON_REPOSITORY = '____PHPBENCHMARKS_SLUG____-common';
+    public const COMMON_REPOSITORY = '____PHPBENCHMARKS_COMPONENT_SLUG____-common';
 
     public const DEPENDENCY_NAME = "____PHPBENCHMARKS_DEPENDENCY_NAME____";
     public const DEPENDENCY_MAJOR_VERSION = ____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____;
diff --git a/docker/composerUpdate/Dockerfile b/docker/composerUpdate/Dockerfile
@@ -1,4 +1,4 @@
-FROM phpbenchmarks/benchmark-kit:1.0.0
+FROM phpbenchmarks/benchmark-kit:1.0.1
 
 COPY entrypoint.sh /var/phpbenchmarks
 RUN chmod +x /var/phpbenchmarks/entrypoint.sh
diff --git a/docker/composerUpdate/createEnv.sh b/docker/composerUpdate/createEnv.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-readonly ENV_DIR="$(dirname $0)/docker/composerUpdate"
+readonly ENV_DIR="$BENCHMARK_KIT_PATH/docker/composerUpdate"
 
 echoValidationGroupStart "Create $ENV_DIR/.env"
 
diff --git a/documentation/installation.md b/documentation/installation.md
@@ -9,13 +9,13 @@ You will need this dependencies to make it work:
 Installation
 -
 
+Add `phpbenchmarks/benchmark-kit` as dependency of your projet.
+
+Not you have to do it in `require`, not in `require-dev`.
+As benchmark kit contains only bash scripts, requiring it will not affect your code until you call them manually.
+
 ```bash
-mkdir ~/benchmarkKit
-cd ~/benchmarkKit
-echo '{"require": {"phpbenchmarks/benchmark-kit": "^1.0"}}' > composer.json
-docker run --rm -v $(pwd):/app composer/composer update
-# composer update is called with root user, so change permissions to current user
-sudo chown -R $USER:$USER vendor
+composer require phpbenchmarks/benchmark-kit ^1.0
 ```
 
 [Back to documentation index](../README.md)
diff --git a/initializeBranch.sh b/initializeBranch.sh
@@ -1,7 +1,9 @@
 #!/usr/bin/env bash
 
-source common.sh
-source validation/configurationValidation.sh
+# Assume that we are in vendor/bin directory. If you know how to get the real path of this script, don't hesitate ;)
+readonly BENCHMARK_KIT_PATH=$(dirname $(cd `dirname $0` && pwd))"/phpbenchmarks/benchmark-kit"
+source $BENCHMARK_KIT_PATH/common.sh
+source $BENCHMARK_KIT_PATH/validation/configurationValidation.sh
 
 function downloadGitHubFile {
     local file=$1
@@ -123,8 +125,8 @@ function createConfigurationFile {
     defineVariableInConfigurationFile "PHPBENCHMARKS_PHP_7_3_ENABLED" "$PHPBENCHMARKS_PHP_7_3_ENABLED" false "true/false"
 
     echo "" >> $configurationFilePath
-    defineVariableInConfigurationFile "PHPBENCHMARKS_NAME" "$PHPBENCHMARKS_NAME" true
-    defineVariableInConfigurationFile "PHPBENCHMARKS_SLUG" "$PHPBENCHMARKS_SLUG" true
+    defineVariableInConfigurationFile "PHPBENCHMARKS_COMPONENT_NAME" "$PHPBENCHMARKS_COMPONENT_NAME" true
+    defineVariableInConfigurationFile "PHPBENCHMARKS_COMPONENT_SLUG" "$PHPBENCHMARKS_COMPONENT_SLUG" true
 
     echo "" >> $configurationFilePath
     defineVariableInConfigurationFile "PHPBENCHMARKS_BENCHMARK_URL" "$PHPBENCHMARKS_BENCHMARK_URL" true
@@ -146,7 +148,7 @@ function createInitBenchmarkFile {
     if [ ! -f "$initBenchmarkPath" ]; then
         echoValidationGroupStart "Create .phpbenchmarks/initBenchmark.sh"
 
-        cp validation/mainRepository/.phpbenchmarks/initBenchmark.sh $INSTALLATION_PATH/.phpbenchmarks/
+        cp "$BENCHMARK_KIT_PATH/validation/mainRepository/.phpbenchmarks/initBenchmark.sh" "$INSTALLATION_PATH/.phpbenchmarks/"
         [ $? != "0" ] && exitScript "Error while writing $initBenchmarkPath."
         echoValidatedTest "File created."
         echoValidatedTest "Function initBenchmark() created."
@@ -165,7 +167,7 @@ function createVhostFile {
     if [ ! -f "$vhostPath" ]; then
         echoValidationGroupStart "Create .phpbenchmarks/vhost.conf"
 
-        cp validation/mainRepository/.phpbenchmarks/vhost.conf $INSTALLATION_PATH/.phpbenchmarks/
+        cp "$BENCHMARK_KIT_PATHvalidation/mainRepository/.phpbenchmarks/vhost.conf" "$INSTALLATION_PATH/.phpbenchmarks/"
         [ $? != "0" ] && exitScript "Error while writing $vhostPath."
         echoValidatedTest "File created."
         echoValidationWarning ".phpbenchmarks/vhost.conf has been created with default nginx virtual host configuration. Edit it if needed."
diff --git a/validation/common.sh b/validation/common.sh
@@ -2,7 +2,6 @@
 
 COMPONENT_TYPE=$1
 RESULT_TYPE_SLUG=$2
-INSTALLATION_PATH=$3
 showCliWarning=false
 
 if [ "$COMPONENT_TYPE" != "framework" ] && [ "$COMPONENT_TYPE" != "templateEngine" ]; then
@@ -29,19 +28,16 @@ if [ "$RESULT_TYPE_SLUG" != "hello-world" ] && [ "$RESULT_TYPE_SLUG" != "rest-ap
     exitScript "Invalid benchmark type."
 fi
 
-if [ "$INSTALLATION_PATH" == "" ]; then
-    showCliWarning=true
-    echoAsk "Path to your code?" false
-    echo ""
-    read INSTALLATION_PATH
-fi
-if [ ! -d "$INSTALLATION_PATH" ]; then
-    exitScript "Invalid path to your code: $INSTALLATION_PATH."
-fi
-
 if [ $showCliWarning == true ]; then
-    echoWarning "You could use \"$0 $COMPONENT_TYPE $RESULT_TYPE_SLUG $INSTALLATION_PATH\"."
+    echoWarning "You could use \"$0 $COMPONENT_TYPE $RESULT_TYPE_SLUG\"."
 fi
 
-readonly RESULT_TYPE_PATH="$(dirname $0)/validation/$COMPONENT_TYPE/$RESULT_TYPE_SLUG"
+readonly INSTALLATION_PATH="$BENCHMARK_KIT_PATH/../../.."
+readonly RESULT_TYPE_PATH="$BENCHMARK_KIT_PATH/validation/$COMPONENT_TYPE/$RESULT_TYPE_SLUG"
+if [ ! -d $RESULT_TYPE_PATH ]; then
+    exitScript "$RESULT_TYPE_PATH is not a valid directory."
+fi
 readonly CONFIGURATION_PATH="$RESULT_TYPE_PATH/componentFiles/.phpbenchmarks"
+if [ ! -d "$CONFIGURATION_PATH" ]; then
+    mkdir "$CONFIGURATION_PATH"
+fi
diff --git a/validation/configurationValidation.sh b/validation/configurationValidation.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-source "$(dirname $0)/validation/common.sh"
+source "$BENCHMARK_KIT_PATH/validation/common.sh"
 
 function copyConfigurationFiles {
     local destinationPath=$1
@@ -52,13 +52,13 @@ function assertCommonConfiguration {
         && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_PHP_7_3_ENABLED. See README.md for more informations."
     echoValidatedTest "[.phpbenchmarks/configuration.sh] Define \$PHPBENCHMARKS_PHP_7_3_ENABLED ($PHPBENCHMARKS_PHP_7_3_ENABLED)."
 
-    [ "$PHPBENCHMARKS_NAME" == "" ] \
-        && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_NAME. See README.md for more informations."
-    echoValidatedTest "[.phpbenchmarks/configuration.sh] Define \$PHPBENCHMARKS_NAME ($PHPBENCHMARKS_NAME)."
+    [ "$PHPBENCHMARKS_COMPONENT_NAME" == "" ] \
+        && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_COMPONENT_NAME. See README.md for more informations."
+    echoValidatedTest "[.phpbenchmarks/configuration.sh] Define \$PHPBENCHMARKS_COMPONENT_NAME ($PHPBENCHMARKS_COMPONENT_NAME)."
 
-    [ "$PHPBENCHMARKS_SLUG" == "" ] \
-        && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_SLUG. See README.md for more informations."
-    echoValidatedTest "[.phpbenchmarks/configuration.sh] Define \$PHPBENCHMARKS_SLUG ($PHPBENCHMARKS_SLUG)."
+    [ "$PHPBENCHMARKS_COMPONENT_SLUG" == "" ] \
+        && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_COMPONENT_SLUG. See README.md for more informations."
+    echoValidatedTest "[.phpbenchmarks/configuration.sh] Define \$PHPBENCHMARKS_COMPONENT_SLUG ($PHPBENCHMARKS_COMPONENT_SLUG)."
 
     [ "$PHPBENCHMARKS_BENCHMARK_URL" == "" ] \
         && exitScript "[.phpbenchmarks/configuration.sh] Should define \$PHPBENCHMARKS_BENCHMARK_URL. See README.md for more informations."
diff --git a/validation/framework/hello-world/docker/codeValidation/Dockerfile b/validation/framework/hello-world/docker/codeValidation/Dockerfile
@@ -1,4 +1,4 @@
-FROM phpbenchmarks/benchmark-kit:1.0.0
+FROM phpbenchmarks/benchmark-kit:1.0.1
 
 # copy config files
 COPY componentFiles/.phpbenchmarks /var/phpbenchmarks/componentFiles/.phpbenchmarks/
diff --git a/validation/mainRepository/README.md b/validation/mainRepository/README.md
@@ -14,18 +14,18 @@ Our benchmarking protocol is available on [benchmarking protocol page](http://ww
 
 ## What is this repository ?
 
-It contains ____PHPBENCHMARKS_NAME____ installation `only`.
+It contains ____PHPBENCHMARKS_COMPONENT_NAME____ installation `only`.
 To reuse code between minor versions, features for benchmarks are not coded in this repository
-but in [phpbenchmarks/____PHPBENCHMARKS_SLUG____-common](https://github.com/phpbenchmarks/____PHPBENCHMARKS_SLUG____-common) repository.
+but in [phpbenchmarks/____PHPBENCHMARKS_COMPONENT_SLUG____-common](https://github.com/phpbenchmarks/____PHPBENCHMARKS_COMPONENT_SLUG____-common) repository.
 
 Switch branch to select version and benchmark you want to see.
 
 ## Benchmarks
 
-You can find ____PHPBENCHMARKS_NAME____ ____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____.____PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION____ benchmarks results on
-[benchmarks results page](http://www.phpbenchmarks.com/en/benchmark/____PHPBENCHMARKS_SLUG____/____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____.____PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION____).
+You can find ____PHPBENCHMARKS_COMPONENT_NAME____ ____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____.____PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION____ benchmarks results on
+[benchmarks results page](http://www.phpbenchmarks.com/en/benchmark/____PHPBENCHMARKS_COMPONENT_SLUG____/____PHPBENCHMARKS_DEPENDENCY_MAJOR_VERSION____.____PHPBENCHMARKS_DEPENDENCY_MINOR_VERSION____).
 
-See all ____PHPBENCHMARKS_NAME____ benchmarked versions on [select version page](http://www.phpbenchmarks.com/en/benchmark/____PHPBENCHMARKS_SLUG____/version).
+See all ____PHPBENCHMARKS_COMPONENT_NAME____ benchmarked versions on [select version page](http://www.phpbenchmarks.com/en/benchmark/____PHPBENCHMARKS_COMPONENT_SLUG____/version).
 
 ## Community
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM phpbenchmarks/benchmark-kit:1.0.0`
	`1`	`+FROM phpbenchmarks/benchmark-kit:1.0.1`
`2`	`2`
`3`	`3`	`COPY entrypoint.sh /var/phpbenchmarks`
`4`	`4`	`RUN chmod +x /var/phpbenchmarks/entrypoint.sh`