Add TESTING instructions for web interface
diff mbox

Message ID 20170412045616.26842-1-mark.weiman@markzz.com
State Accepted, archived
Headers show

Commit Message

Mark Weiman April 12, 2017, 4:56 a.m. UTC
Add instructions to test aurweb's web interface via the PHP built-in web
server.

Signed-off-by: Mark Weiman <mark.weiman@markzz.com>
---
 INSTALL |  8 ++++++++
 TESTING | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 TESTING

Comments

Lukas Fleischer April 12, 2017, 5:27 a.m. UTC | #1
On Wed, 12 Apr 2017 at 06:56:16, Mark Weiman wrote:
> Add instructions to test aurweb's web interface via the PHP built-in web
> server.
> 
> Signed-off-by: Mark Weiman <mark.weiman@markzz.com>
> ---
>  INSTALL |  8 ++++++++
>  TESTING | 32 ++++++++++++++++++++++++++++++++
>  2 files changed, 40 insertions(+)
>  create mode 100644 TESTING
> [...]

Awesome. Queued, thanks!

Patch
diff mbox

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..760e5d2
--- /dev/null
+++ b/TESTING
@@ -0,0 +1,32 @@ 
+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
+    $ make
+    $ ./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 the PHP built-in web server
+
+   $ AUR_CONFIG='/path/to/aurweb/conf/config' php -S localhost:8080 -t /path/to/aurweb/web/html