https://github.com/fylein/fyle-netsuite-api
Backend repository for Fyle <> Netsuite integration
https://github.com/fylein/fyle-netsuite-api
team-integrations
Last synced: 2 months ago
JSON representation
Backend repository for Fyle <> Netsuite integration
- Host: GitHub
- URL: https://github.com/fylein/fyle-netsuite-api
- Owner: fylein
- License: mit
- Created: 2020-05-26T05:57:02.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T10:10:32.000Z (about 1 year ago)
- Last Synced: 2024-04-09T10:27:30.011Z (about 1 year ago)
- Topics: team-integrations
- Language: Python
- Size: 5.54 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fyle NetSuite API
Django Rest Framework API for Fyle Netsuite Integration.
### Setup
* Add and update the `fyle_integrations_imports` submodule
```bash
$ git submodule init
$ git submodule update
```
* ### Adding a New View, Function, or Trigger:
Follow these steps to ensure your changes are applied correctly:
1. **Make changes** in the [`fyle-integrations-db-migrations`](https://github.com/fylein/fyle-integrations-db-migrations) repository.
2. **Update the submodule** in the Netsuite API:
```bash
git submodule init
git submodule update
```
3. **Enter the Netsuite API container**:
```bash
enter netsuite-api
```
4. **Generate a migration file** using the provided convenient command:
```bash
python3 manage.py create_sql_migration
```
- Replace `` with the relative path to your SQL file from the fyle-integrations-db-migrations folder.
- The migration will always be created in the `internal` app.
**Example:**
```bash
python3 manage.py create_sql_migration fyle-integrations-db-migrations/netsuite/functions/re_export_expenses_netsuite.sql
```
5. **Review the newly generated migration file**:
Navigate to the `apps/internal/migrations/` directory and ensure the migration file content is as expected.
6. **Restart the Netsuite API service and apply the migration**:
```bash
restart netsuite-api
logs netsuite-api
```
Confirm in the logs that the migration has been applied successfully.
* Download and install Docker desktop for Mac from [here.](https://www.docker.com/products/docker-desktop)
* If you're using a linux machine, please download docker according to the distrubution you're on.
* Rename docker-compose.yml.template to docker-compose.yml
```
$ mv docker-compose.yml.template docker-compose.yml
```
* Setup environment variables in docker_compose.yml
```yaml
environment:
SECRET_KEY: thisisthedjangosecretkey
ALLOWED_HOSTS: "*"
DEBUG: "False"
API_URL: http://localhost:8000/api
DATABASE_URL: postgres://postgres:postgres@db:5432/netsuite_db
FYLE_BASE_URL:
FYLE_CLIENT_ID:
FYLE_CLIENT_SECRET:
FYLE_TOKEN_URI:
NS_CONSUMER_KEY:
NS_CONSUMER_SECRET:
```
* Build docker images
```
docker-compose build api qcluster
```
* Run docker containers
```
docker-compose up -d db api qcluster
```
* The database can be accessed by this command, on password prompt type `postgres`
```
docker-compose run db psql -h db -U postgres netsuite_db
```
* To tail the logs a service you can do
```
docker-compose logs -f
```
* To stop the containers
```
docker-compose stop api qcluster
```
* To restart any containers - `would usually be needed with qcluster after you make any code changes`
```
docker-compose restart qcluster
```
* To run bash inside any container for purpose of debugging do
```
docker-compose exec api /bin/bash
```
### Running Tests
* Add the following environment variables to setup.sh file
```
export API_URL='http://localhost:8000/api'
export FYLE_BASE_URL='
export FYLE_CLIENT_ID=''
export FYLE_CLIENT_SECRET=''
export FYLE_REFRESH_TOKEN=''
export FYLE_TOKEN_URI='fyle_token_uri'
export NS_ACCOUNT_ID=''
```
* Run the following commands
```
docker-compose -f docker-compose-pipeline.yml build
docker-compose -f docker-compose-pipeline.yml up -d
docker-compose -f docker-compose-pipeline.yml exec api pytest tests/
```
* Run the following command to update tests SQL fixture (`tests/sql_fixtures/reset_db_fixtures/reset_db.sql`)
```
docker-compose -f docker-compose-pipeline.yml exec api /bin/bash tests/sql_fixtures/migration_fixtures/create_migration.sh
```
* You should see output like this
```
Sravans-MacBook-Air:fyle-netsuite-api sravankumar$ pytest apps/users/tests/
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
......
----------------------------------------------------------------------
Ran 6 tests in 15.670s
OK
Destroying test database for alias 'default'...
```