Project attempts to clone the the AirBnB listing page, including the database, storage, RESTful API, Web Framework, and Front End.
- OS: Ubuntu 14.04 LTS
- language: Python 3.4.3
- web server: nginx/1.4.6
- application server: Flask 0.12.2, Jinja2 2.9.6
- web server gateway: gunicorn (version 19.7.1)
- database: mysql Ver 14.14 Distrib 5.7.18
- documentation: Swagger (flasgger==0.6.6)
- style:
- python: PEP 8 (v. 1.7.0)
- web static: W3C Validator
- bash: ShellCheck 0.3.3
Currently the application is designed to run with 2 storage engine models:
-
File Storage Engine:
/models/engine/file_storage.py
-
Database Storage Engine:
-
/models/engine/db_storage.py -
To Setup the DataBase for testing and development, there are 2 setup scripts that setup a database with certain privileges:
setup_mysql_test.sql&setup_mysql_test.sql(for more on setup, see below). -
The Database uses Environmental Variables for tests. To execute tests with the environmental variables prepend these declarations to the execution command:
-
$ HBNB_MYSQL_USER=hbnb_test HBNB_MYSQL_PWD=hbnb_test_pwd \
HBNB_MYSQL_HOST=localhost HBNB_MYSQL_DB=hbnb_test_db HBNB_TYPE_STORAGE=db \
[COMMAND HERE]
The /config/ directory contains configuration files for nginx and the
Upstart scripts. The nginx configuration file is for the configuration file in
the path: /etc/nginx/sites-available/default. The enabled site is a sym link
to that configuration file. The upstart script should be saved in the path:
/etc/init/[FILE_NAME.conf]. To begin this service, execute:
$ sudo start airbnb.conf
This script's main task is to execute the following gunicorn command:
$ gunicorn --bind 127.0.0.1:8001 wsgi.wsgi:web_flask.app
The gunicorn command starts an instance of a Flask Application.
All integration with gunicorn occurs with Upstart .conf files. The Python
code for the WSGI is listed in the /wsgi/ directory. These python files run
the designated Flask Application.
This project comes with various setup scripts to support automation, especially during maintanence or to scale the entire project. The following files are the setupfiles along with a brief explanation:
-
dev/setup.sql: Drops test and dev databases, and then reinitializes the datbase.- Usage:
$ cat dev/setup.sql | mysql -uroot -p
- Usage:
-
setup_mysql_dev.sql: initialiezs dev database with mysql for testing- Usage:
$ cat setup_mysql_dev.sql | mysql -uroot -p
- Usage:
-
setup_mysql_test.sql: initializes test database with mysql for testing- Usage:
$ cat setup_mysql_test.sql | mysql -uroot -p
- Usage:
-
0-setup_web_static.sh: sets up nginx web server config file & the file structure.- Usage:
$ sudo ./0-setup_web_static.sh
- Usage:
-
3-deploy_web_static.py: uses 2 functions from (1-pack_web_static.py & 2-do_deploy_web_static.py) that use the fabric3 python integration, to create a.tgzfile on local host of all the local web static fils, and then calls the other function to deploy the compressed web static files. Command must be executed from theAirBnB_cloneroot directory.- Usage:
$ fab -f 3-deploy_web_static.py deploy -i ~/.ssh/holberton -u ubuntu
- Usage:
This project uses python library, unittest to run tests on all python files.
All unittests are in the ./tests directory with the command:
-
File Storage Engine Model:
$ python3 -m unittest discover -v ./tests/
-
DataBase Storage Engine Model
$ HBNB_MYSQL_USER=hbnb_test HBNB_MYSQL_PWD=hbnb_test_pwd \
HBNB_MYSQL_HOST=localhost HBNB_MYSQL_DB=hbnb_test_db HBNB_TYPE_STORAGE=db \
python3 -m unittest discover -v ./tests/
The bash script init_test.sh executes all these tests for both File Storage &
DataBase Engine Models:
-
checks
pep8style -
runs all unittests
-
runs all w3c_validator tests
-
cleans up all
__pycache__directories and the storage file,file.json -
Usage
init_test.sh:
$ ./dev/init_test.sh
- This project uses python library,
cmdto run tests in an interactive command line interface. To begin tests with the CLI, run this script:
$ ./console.py
$ HBNB_MYSQL_USER=hbnb_test HBNB_MYSQL_PWD=hbnb_test_pwd \
HBNB_MYSQL_HOST=localhost HBNB_MYSQL_DB=hbnb_test_db HBNB_TYPE_STORAGE=db \
./console.py
(hbnb) help help
List available commands with "help" or detailed help with "help cmd".
(hbnb) help
Documented commands (type help <topic>):
========================================
Amenity City Place State airbnb create help show
BaseModel EOF Review User all destroy quit update
(hbnb) help User
class method with .function() syntax
Usage: User.<command>(<id>)
(hbnb) help create
create: create [ARG] [PARAM 1] [PARAM 2] ...
ARG = Class Name
PARAM = <key name>=<value>
value syntax: "<value>"
SYNOPSIS: Creates a new instance of the Class from given input ARG
and PARAMS. Key in PARAM = an instance attribute.
EXAMPLE: create City name="Chicago"
City.create(name="Chicago")
-
Tests in the CLI may also be executed with this syntax:
-
destroy:
<class name>.destroy(<id>) -
update:
<class name>.update(<id>, <attribute name>, <attribute value>) -
update with dictionary:
<class name>.update(<id>, <dictionary representation>)
-
Uses Travis-CI to run all tests on all commits to the github repo
"#### SCRIPT LOADED ####"
-> means the page has successfully incorporated present jquery scripts
"#### BOX CHECKED ####"
-> confirms the checkbox being filled is read properly.
"#### BOX UNCHECKED ####"
-> confirms the checkbox is unfilled and read properly.
"#### API OK ####"
-> connection to api is working.
"#### API NOT OK ####"
-> connection to api is not working.
"#### POST SUCCESS ####"
-> post request was successful.
"#### DATA ####"
-> data is readable
"#### Error, status = ' + textStatus + ', ' + 'error thrown: ' + errorThrown ####"
-> shows error and supporting information
"#### Peeling JSON onion ####"
-> able to read json data to be used for html render
- MJ Johnson, @mj31508
- David John Coleman II, davidjohncoleman.com | @djohncoleman
- Kimberly Wong, kjowong | @kjowong | kjowong@gmail.com
- Carrie Ybay, hicarrie | @hicarrie_
- Jared Heck, jarehec | @jarehec
- Andrew Graf, @humeinstein
- Gareth Brickman, @garethbrickman
MIT License