You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/12/03 03:47:33 UTC

[GitHub] [apisix] Firstsawyou opened a new pull request #2941: docs: update doc of test

Firstsawyou opened a new pull request #2941:
URL: https://github.com/apache/apisix/pull/2941


   fix #2936
   
   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   <!--- If it fixes an open issue, please link to the issue here. -->
   
   ### Pre-submission checklist:
   
   * [ ] Did you explain what problem does this PR solve? Or what new features have been added?
   * [ ] Have you added corresponding test cases?
   * [x] Have you modified the corresponding document?
   * [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] Firstsawyou commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535872864



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       What I think is necessary, before running a single test case, if we have not executed the `make test` command, then `t/toolkit` is an empty directory. Therefore, we need to explain how to download this test kit. At the same time, this is also to show that our test cases depend on the `test-toolkit` package. I will add the reason why this command `git clone https://github.com/api7/test-toolkit/t/toolkit` failed later.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] Firstsawyou commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535874299



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       > Oh, I think we can remove it.Let user clone it is very danger
   
   Oh, this is also a method. We can remove it if needed.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] ShiningRush commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
ShiningRush commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535868084



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       Oh, I think we can remove it.Let user clone it is very danger




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] spacewander commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535874963



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       @Firstsawyou 
   But the doc already requires user to run `make test`.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] Firstsawyou commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535880387



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       Understand, this pr seems to be redundant, we can turn it off.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] membphis closed pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
membphis closed pull request #2941:
URL: https://github.com/apache/apisix/pull/2941


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] spacewander commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535866953



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       Do we need this after https://github.com/apache/apisix/pull/2934?
   And this command is incorrect. Running it will get `fatal: destination path 't/toolkit' already exists and is not an empty directory.`




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] ShiningRush commented on a change in pull request #2941: docs: update doc of test

Posted by GitBox <gi...@apache.org>.
ShiningRush commented on a change in pull request #2941:
URL: https://github.com/apache/apisix/pull/2941#discussion_r535868084



##########
File path: doc/how-to-build.md
##########
@@ -119,17 +119,29 @@ Makefile rules:
 ### Troubleshoot Testing
 
 **Set Nginx Path**
+
 - If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
 make sure to set openresty as default nginx. And export the path as below.
+
 * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - Linux default installation path:
         * export PATH=/usr/local/openresty/nginx/sbin:$PATH
     - OSx default installation path via homebrew:
         * export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
 
 **Run Individual Test Cases**
+
+Because the test case of `apisix` depends on the https://github.com/api7/test-toolkit test kit. Therefore, before running a single test case, you need to execute `make test` to automatically download the test kit or manually clone the `test-toolkit` to the `apisix/t/` directory:
+
+```shell
+git clone https://github.com/api7/test-toolkit/ t/toolkit

Review comment:
       Oh, I think we can remove it.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org