diff --git a/Documentation/source/development.rst b/Documentation/source/development.rst index 362ca56..8026473 100644 --- a/Documentation/source/development.rst +++ b/Documentation/source/development.rst @@ -14,16 +14,39 @@ Below is a documentation what to respect during contributions. Setup ----- -To start contributions regarding code, make sure to setup your system:: +To start contributions regarding code, make sure your environment matches the following +requirements: + +* composer is executable + +* PHP on CLI is executable + +* MySQL is up and running with user *dev* and password *dev* on *127.0.0.1* or to overwrite the + environment variables, see :file:`Makefile`. + And MySQL is not set to strict mode as TYPO3 doesn't support strict mode, see + https://review.typo3.org/#/c/26725/3/INSTALL.md. + +* Elasticsearch is installed and up and running on *localhost:9200*. + +Then setup your system:: git clone git@github.com:DanielSiepmann/search_core.git \ && cd search_core \ + && export typo3DatabaseName="searchcoretest62" \ + && export TYPO3_VERSION="~6.2" \ && make install \ && make functionalTests If all tests are okay, start your work. -Of course you might need some requirements like running elasticsearch and composer to work before. +If you are working with multiple TYPO3 versions make sure to export `typo3DatabaseName` and +`TYPO3_VERSION` in your environment like:: + + export typo3DatabaseName="searchcoretest76" + export TYPO3_VERSION="~7.6" + +Also run the install command for each version before running any tests. Only this will make sure you +are testing against the actual TYPO3 Version and database scheme. .. _contribution_development: @@ -34,7 +57,7 @@ All changes are introduced through pull requests at `Github`_ and should contain * Adjusted tests if tests existed before. Otherwise they will break on `travis-ci`_. -* New tests whenever possible and usefull. +* New tests whenever possible and useful. * Code has to follow `PSR-2`_. diff --git a/Makefile b/Makefile index bc80924..e32cdaa 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ current_dir := $(dir $(mkfile_path)) TYPO3_WEB_DIR := $(current_dir).Build/Web # Allow different versions on travis TYPO3_VERSION ?= ~6.2.19 -typo3DatabaseName ?= "test" +typo3DatabaseName ?= "searchcore_test" typo3DatabaseUsername ?= "dev" typo3DatabasePassword ?= "dev" typo3DatabaseHost ?= "127.0.0.1" diff --git a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignDb.xml b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignDb.xml index c581790..3b2e2bb 100644 --- a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignDb.xml +++ b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignDb.xml @@ -7,6 +7,7 @@ 2,3
Record 1
0 + 0 2 @@ -14,6 +15,7 @@ header
Record 2
0 + 0
3 @@ -21,5 +23,6 @@ header
Record 3
0 + 0
diff --git a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignMmSelect.xml b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignMmSelect.xml index ff9ad47..7639771 100644 --- a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignMmSelect.xml +++ b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/ForeignMmSelect.xml @@ -7,6 +7,7 @@
Record with relation to multiple sys category record
0 3 + 0 @@ -18,6 +19,7 @@ Category for testing 0 1 + @@ -29,6 +31,7 @@ Another category for testing 1 1 + @@ -40,6 +43,7 @@ 0 1 + diff --git a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/InlineRelation.xml b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/InlineRelation.xml index b60804d..2c54bf9 100644 --- a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/InlineRelation.xml +++ b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/InlineRelation.xml @@ -12,6 +12,7 @@ 0 1 Metadata title 1 + @@ -19,6 +20,7 @@ 0 1 Metadata title 2 + @@ -26,5 +28,6 @@ 0 2 Metadata title with no relation + diff --git a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/StaticSelectItems.xml b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/StaticSelectItems.xml index e2a5319..925205f 100644 --- a/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/StaticSelectItems.xml +++ b/Tests/Functional/Fixtures/Indexing/TcaIndexer/RelationResolver/StaticSelectItems.xml @@ -6,5 +6,6 @@ list 1 0 + 0