commit	15b1b7fdc00fb7a48064eed805c63220efebdff3	[log] [tgz]
author	Patrick Lu <patricklu@google.com>	Wed May 17 22:27:54 2023 +0000
committer	CQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>	Wed May 17 22:27:54 2023 +0000
tree	e8a0b8c0df4752f0be8fc55b5b0222568a00b764
parent	0d9e3581d57f376865f49ae62fe9171789beca56 [diff]

tree: e8a0b8c0df4752f0be8fc55b5b0222568a00b764

README.md

antlion

Collection of host-driven, hardware-agnostic Fuchsia connectivity tests. Mainly targeting WLAN and Netstack testing.

Getting Started

Requires Python 3.8+

Clone the repo

git clone https://fuchsia.googlesource.com/antlion

Install dependencies using venv

cd antlion
python3 -m venv .venv      # Create a virtual environment in the `.venv` directory
source .venv/bin/activate  # Activate the virtual environment
pip install --editable .
# Run `deactivate` later to exit the virtual environment

Write the sample config and update the Fuchsia controller to match your development environment

mkdir -p config
cat <<EOF > config/simple.json
{
   "testbed": [{
      "name": "simple_testbed",
      "FuchsiaDevice": [{
         "ip": "fuchsia-00e0-4c01-04df"
      }]
   }],
   "logpath": "logs"
}
EOF

Run the sanity test

antlion -c config/simple.json -tc Sl4fSanityTest

See antlion -h for more full usage.

Contributing

Contributions are what make open source projects a great place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please create a CL.

Before contributing, a few more tools are necessary:

Install these additional dependencies:
```
pip install --editable ".[dev]"
```
Install the EditorConfig plugin for your editor
Install Black our preferred code formatter. Optionally, add the extension to your editor.
Complete the steps in ‘Contribute source changes’ to gain authorization

To create a CL:

Create a feature branch (git checkout -b feature/amazing-feature)
Document your change in CHANGELOG.md
Run your change through Black formatter
Commit changes (git add . && git commit -m 'Add some amazing feature')
Upload CL (git push origin HEAD:refs/for/main)

A public bug tracker is not (yet) available.

Recommended git aliases

There are a handful of git commands that will be commonly used throughout the process of contributing. Here are a few aliases to add to your git config (~/.gitconfig) for a smoother workflow:

git amend to modify your CL in response to code review comments
git uc to upload your CL, run pre-submit tests, enable auto-submit, and add a reviewer

[alias]
  amend = commit --amend --no-edit
  uc = push origin HEAD:refs/for/main%l=Commit-Queue+1,l=Fuchsia-Auto-Submit+1,publish-comments,r=sbalana

You may also want to add a section to ignore the project's large formatting changes:

[blame]
  ignoreRevsFile = .git-blame-ignore-revs

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Acknowledgments

This is a fork of ACTS, the connectivity testing framework used by Android. The folks over there did a great job at cultivating amazing tools, much of which are being used or have been extended with additional features.

Migrating CLs from ACTS

antlion and ACTS share the same git history, so migrating existing changes is straightforward:

Checkout to latest main

git checkout main
git pull --rebase origin main

Cherry-pick the ACTS change

git fetch acts refs/changes/16/12345/6 && git checkout -b change-12345 FETCH_HEAD
git fetch https://android.googlesource.com/platform/tools/test/connectivity refs/changes/30/2320530/1 && git cherry-pick FETCH_HEAD

Resolve any merge conflicts, if any
```
git add [...]
git rebase --continue
```

Upload CL

git push origin HEAD:refs/for/main # or "git uc" if using the alias