[4/4] Add TESTING instructions for web interface

Message ID 20170301064621.19031-4-mark.weiman@markzz.com
State Accepted, archived
Headers show
Series
  • [1/4] Add sqlite3 schema for testing databases
Related show

Commit Message

Mark Weiman March 1, 2017, 6:46 a.m. UTC
Signed-off-by: Mark Weiman <mark.weiman@markzz.com>
---
 INSTALL |  8 ++++++++
 TESTING | 31 +++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 TESTING

Comments

Lukas Fleischer March 1, 2017, 7:28 p.m. UTC | #1
On Wed, 01 Mar 2017 at 07:46:21, Mark Weiman wrote:
> +Setup Testing Environment
> +=========================
> +
> +Note that this setup is only to test the web interface. If you need to have a
> +full aurweb instance with cgit, ssh interface, etc, follow the directions in
> +INSTALL.
> +
> +1) Clone the aurweb project:
> +
> +    $ git clone git://git.archlinux.org/aurweb.git
> +
> +2) Install php and necessary modules:
> +
> +    # pacman -S php php-sqlite sqlite
> +
> +3) Prepare the testing database:
> +
> +    $ cd /path/to/aurweb/schema

This needs to be updated to work with the two patches I just submitted.
An additional

    $ make

should be sufficient.

> +    $ ./gendummydata.py out.sql
> +    $ sqlite3 ../aurweb.sqlite3 < aur-schema-sqlite.sql
> +    $ sqlite3 ../aurweb.sqlite3 < out.sql
> +
> +4) Copy conf/config.proto to conf/config and adjust the configuration
> +   (pay attention to disable_http_login, enable_maintenance and aur_location).
> +
> +   Be sure to change backend to sqlite and name to the file location of your
> +   created test database.
> +
> +5) Run PHP Command Line server

Minor nit: I would change this line to "Run the PHP built-in web server"
and also add a colon at the end.

This looks great otherwise! It would be nice if you could fix this
last sentence, add the additional `make` invocation and resubmit. In the
meantime, I will queue patches two and three of this series in pu.
Thanks!

> +
> +   $ AUR_CONFIG='/path/to/aurweb/conf/config' php -S localhost:8080 -t /path/to/aurweb/web/html
> -- 
> 2.12.0

Patch

diff --git a/INSTALL b/INSTALL
index a472b27..8c9c4dd 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,14 @@ 
 Setup on Arch Linux
 ===================
 
+For testing aurweb patches before submission, you can use the instructions in
+TESTING for testing the web interface only.
+
+Note that you can only do limited testing using the PHP built-in web server.
+In particular, the cgit interface will be unusable as well as the ssh+git
+interface. For a detailed description on how to setup a full aurweb server,
+read the instructions below.
+
 1) Clone the aurweb project:
 
    $ cd /srv/http/
diff --git a/TESTING b/TESTING
new file mode 100644
index 0000000..00a9e98
--- /dev/null
+++ b/TESTING
@@ -0,0 +1,31 @@ 
+Setup Testing Environment
+=========================
+
+Note that this setup is only to test the web interface. If you need to have a
+full aurweb instance with cgit, ssh interface, etc, follow the directions in
+INSTALL.
+
+1) Clone the aurweb project:
+
+    $ git clone git://git.archlinux.org/aurweb.git
+
+2) Install php and necessary modules:
+
+    # pacman -S php php-sqlite sqlite
+
+3) Prepare the testing database:
+
+    $ cd /path/to/aurweb/schema
+    $ ./gendummydata.py out.sql
+    $ sqlite3 ../aurweb.sqlite3 < aur-schema-sqlite.sql
+    $ sqlite3 ../aurweb.sqlite3 < out.sql
+
+4) Copy conf/config.proto to conf/config and adjust the configuration
+   (pay attention to disable_http_login, enable_maintenance and aur_location).
+
+   Be sure to change backend to sqlite and name to the file location of your
+   created test database.
+
+5) Run PHP Command Line server
+
+   $ AUR_CONFIG='/path/to/aurweb/conf/config' php -S localhost:8080 -t /path/to/aurweb/web/html