Initial commit

Co-authored-by: Daniel Beylkin <dbeylkin@fb.com>
Co-authored-by: Wenteng Ma
Co-authored-by: Zhiqian Deng

Author: wuweicaifb

.coverage

@@ -0,0 +1,22 @@
+[flake8]
+select = B,C,E,F,P,T4,W,B9
+max-line-length = 80
+# E127, E128 are hard to silence in certain nested formatting situations.
+# E265, E266 talk about comment formatting which is too opinionated.
+# E402 warns on imports coming after statements. There are important use cases
+# before imports.
+# E501 is not flexible enough, we're using B950 instead.
+# E722 is a duplicate of B001.
+# P207 is a duplicate of B003.
+# W503 talks about operator formatting which is too opinionated.
+# E203 conflicts with Black
+ignore = E127, E128, E265, E266, E402, E501, E722, P207, W503, E203, T484
+max-complexity = 50
+exclude =
+  .git,
+  .hg,
+  .tox,
+  __init__.py
+  __pycache__,
+  _bin/*,
+  _build/*,

.flake8

@@ -0,0 +1,32 @@
+---
+name: Bug
+about: Use this template for bugs.
+title: "[BUG NAME] - "
+labels: bug
+assignees:
+---
+
+This issue tracker is **ONLY** used for reporting bugs.
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- Tell us what should happen -->
+
+## Current Behavior
+<!--- Tell us what happens instead of the expected behavior -->
+
+## Steps to Reproduce
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- What are you trying to accomplish? How has this issue affected you? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Detailed Description
+<!--- Provide a detailed description of the change or addition you are proposing -->

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,30 @@
+<!--
+Thank you for submitting a Pull Request!
+Please carefully follow the instructions below.
+-->
+
+## Prerequisites
+
+- [ ] I have read the [Contributing Guidelines](../blob/main/CONTRIBUTING.md).
+- [ ] I have read the [Code of Conduct](../blob/main/CODE_OF_CONDUCT.md).
+- [ ] If this is a non-trivial change, I have already opened an accompanying Issue.
+- [ ] If applicable, I have included documentation updates alongside my code changes.
+
+<!--
+Please remember to sign the CLA, although you can also sign it after submitting this Pull Request.
+The CLA is required for us to merge your Pull Request.
+-->
+
+## Description
+
+<!--
+Describe your changes, or link to another Issue or Pull Request.
+-->
+
+## Test Plan
+
+<!--
+Describe how you have tested your changes.
+Please include relevant environment details, logs, screenshots, etc.
+Do not provide customer information that could be considered personally identifiable information (PII).
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docusaurus
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '>=16.14'
+          cache: yarn
+          cache-dependency-path: docusaurus/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docusaurus/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/deploy-gh-pages.yml

@@ -0,0 +1,33 @@
+# Internal use for the private repository owned by Meta only.
+# Delete tests except Sample right before release
+name: Integration Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches:
+     - '*'
+
+jobs:
+  Integration_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Packages
+        run: |
+          sudo apt update
+          sudo apt install -y python3-pip
+          sudo apt install -y gdal-bin
+          sudo apt install -y libgdal-dev
+          export CPLUS_INCLUDE_PATH=/usr/include/gdal
+          export C_INCLUDE_PATH=/usr/include/gdal
+          pip3 install .
+
+      - name: Run Sample
+        run: |
+          python3 -c "import terragraph_planner; \
+          terragraph_planner.optimize_and_report_topology_with_config_file('terragraph_planner/data/sample_plan/config.yaml')"

.github/workflows/integration-test.yml

@@ -0,0 +1,34 @@
+name: Lint
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  Linters:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          pip install -r requirements_dev.txt
+          pre-commit install
+
+      - name: Lint
+        run:  pre-commit run --all-files

.github/workflows/lint.yml

@@ -0,0 +1,42 @@
+name: Pyre
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  Linters:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y gdal-bin
+          sudo apt install -y libgdal-dev
+          export CPLUS_INCLUDE_PATH=/usr/include/gdal
+          export C_INCLUDE_PATH=/usr/include/gdal
+          pip install -r requirements.txt
+          pip install -r requirements_dev.txt
+          pip install cython flask flask_cors graphql-core typing_inspect
+          VERSION=$(grep "version" .pyre_configuration | sed -n -e 's/.*\(0\.0\.[0-9]*\).*/\1/p')
+          pip install pyre-check-nightly==$VERSION
+
+      - name: Run Pyre
+        run: pyre

.github/workflows/pyre.yml

@@ -0,0 +1,28 @@
+name: Unittest
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches:
+     - '*'
+
+jobs:
+  Unittest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Packages
+        run: |
+          sudo apt update
+          sudo apt install -y gdal-bin
+          sudo apt install -y libgdal-dev
+          export CPLUS_INCLUDE_PATH=/usr/include/gdal
+          export C_INCLUDE_PATH=/usr/include/gdal
+          pip install .
+
+      - name: Run All Unittest
+        run: python -m unittest discover terragraph_planner -b

.github/workflows/unittest.yml

@@ -0,0 +1,24 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.ddl
+
+# Files generate by setup.py
+dist/
+build/
+terragraph_planner.egg-info/
+.eggs/
+
+# VS code
+.vscode/
+
+# pyre
+.pyre
+
+# Mac OS X
+**/.DS_Store
+
+# Pyre
+.pyre/