Skip to content

Commit

Permalink
Initial public release
Browse files Browse the repository at this point in the history
  • Loading branch information
pproenca committed Nov 7, 2016
0 parents commit c071c51
Show file tree
Hide file tree
Showing 25 changed files with 954 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
athena.lock
docs/_book/
.gradle/
example-tests/build/
23 changes: 23 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
language: node_js
node_js:
- stable
services:
- docker
before_script:
- npm install -g gitbook-cli
- mkdir -p /opt/athena
- wget -qO- "https://github.com/athena-oss/athena/archive/v0.8.0.tar.gz" | tar --strip-components
1 -zx -C "/opt/athena"
- ln -s "$TRAVIS_BUILD_DIR" "/opt/athena/plugins/gradle"
- touch /opt/athena/plugins/base/athena.lock
- export PATH=$PATH:/opt/athena
script:
- athena gradle exec example-tests/ test
after_success:
- docs/publish_docs
cache:
directories:
- $(npm config get prefix)/bin/gitbook
env:
global:
secure: KpcLuEIP0iC9WhljwJnyRhLLWiM40KuYqhfzriChx0BcGA5NqTKxcueesdMyNDHA+JzsgLRtHt0CclqF9lKwAFz+urFwYasG5/P1kf2rAeyPuk7Lu9m/bjOKC4k+hj3pWW0Zwsn8D2jv7DASoYggbGqsEiko2BTT8LMHLW/Y1Zd6HKvG+OyFWVH76zuuwoIi5076FlCnVaLIkqPU5XRAn93Z5W5SfAc2BF/0QhGiUMfTGzAxhgkjsIuMF4CvoOrTGG/paAsw7NfZOC2tKiawk6G6RfPk3Sno0nYNjKcamDPOIkisUw1GbsjZgCxTUHjjsWnohXgprrwjEctEFKv4AVKzZrkLagpm9FEY58RL/PLaSNQsy0UUZunONsgsSjDkiFL/sYnem7+ilzAMbFO2O0wEvGkerG/A8Hc0PCsWheC1/GIiHDMd7IAI9JYeRFyw9M8nkQmJZT86nIQX9i6s9WiONCwMECgf3B35z7/Gl9/A0GSKZaVrZDFl4Bqa7wFTz5wcQKusJ43DEy65oPe6f5fxaKS79UUtXiZWSvWRzMNZkcqT5G7lpghW19gNDbqWeyDYzbRsz1ypyxIr38Ab6mESb4hW3TVRctL8Mlq4yUoCOPc5ueCBuk+UftGWzge633ndhhEBX99DIlb+4Og2Hgame2k1c5yLMw5pX2faUEA=
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Pedro Proença <pmp.proenca@gmail.com>
Rafael Pinto <santospinto.rafael@gmail.com>
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 0.3.0 (November 7, 2016)

### Athena Plugin Selenium

- Initial public release
96 changes: 96 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Contributing to Athena Gradle Plugin

Athena is the first [OLX](http://www.olx.com/) open source project that is both under very active development and is also being used to automate stuff at [OLX](http://www.olx.com/). We're still working the details to make contributing to this project as easy and transparent as possible. Hopefully with the help of this document and your feedback we will eventually make it.

## Our Development Process

Some of our core contributers will be working directly on GitHub. These changes will be public from the beginning.

### `master` changes fast

We move fast and most likely things will break. Every time there is a commit our CI server will run the tests and hopefully they will pass all times. We will do our best to properly communicate the changes that can affect the application API and always version appropriately in order to make easier for you to use a specific version.

### Pull Requests

The core contributors will be monitoring for pull requests. When we get one, we will pull it in and apply it to our codebase and run our test suite to ensure nothing breaks. Then one of the core contributors needs to verify that all is working appropriately. When the API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.

*Before* submitting a pull request, please make sure the following is done:

1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests!
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes (`athena cli tests`).


## Bugs

### Where to Find Known Issues

We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

### Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case.

## How to Get in Touch

Mailing list - [Athena in Google Groups](https://groups.google.com/a/olx.com/d/forum/athena)

## Development best practices

### Common

* Global Variables :
- **SHOULD** be avoided and used only to store global state
- **MUST** be handled using getters and setters
- **MUST** be named in uppercase, e.g.: ```MY_VARIABLE_NAME```
- **MUST** be prefixed with ATHENA_ when defined in Athena engine and prefixed with ```ATHENA_PLG_${PLUGIN_NAME}_``` when defined in a plugin, e.g.:
- ```ATHENA_MY_VARIABLE_NAME```
- ```ATHENA_PLG_PROXY_MY_VARIABLE_NAME```

* Local variables :
- **MUST** be declared with the local keyword
- **MUST** be named in lowercase


* CLI functions:
* **MUST** be tested and documented
* Documentation **MUST** follow the following format :
```
# Description
# USAGE: <name_of_function> [<arguments>]
# RETURN: <type_of_return>
```
* when used as a core athena function **MUST** follow the naming schema ```athena[.${context}.]${function_name}```
* when used as a global plugin function **MUST** follow the naming schema ```athena.plugins.${plugin_name}.${function_name}```
* **MUST** always return 0 when success and not 0 when fail


* Plugin Commands

* **MUST** NOT have a shebang line
* Arguments **MUST** only be accessed or setted using the functions in ```athena.argument``` library

### Plugins

* Library functions **MUST** be located ```${PLUGIN}/bin/lib``` and when multiple contexts are handled **MUST** follow the naming schema ```${PLUGIN}/bin/lib/functions.${CONTEXT}.sh```, e.g.: ```java/bin/lib/functions.api.sh```

* Library functions **MUST** follow the following name schema : ```athena.plugins.${plugin_name}.${function_name}```


* Folders that are supposed to be mounted in the docker container **MUST** be located in ```${PLUGIN}/mnt/${context}```, e.g.: ```java/mnt/api```

* Source code used per context **MUST** follow a recommended standard, e.g.: PHP **MUST** follow PSR-2, JAVA **MUST** follow Google (https://google.github.io/styleguide/javaguide.html) or other widely adopted

* External libraries **MUST** not be “shipped” with the plugin and **MUST** have a **License** that allows us to use it as we see fit, e.g.: Apache 2.0 License

* Documentation **MUST** be provided

* Examples on HOW TO USE **MUST** be provided

* The init command **MUST** NOT be used directly


## License

By contributing to Athena and Athena Official Plugins, you agree that your contributions will be licensed under the [Apache License Version 2.0 (APLv2)](LICENSE).
192 changes: 192 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.


END OF TERMS AND CONDITIONS


Copyright 2016 OLX

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Gradle Plugin [![Build Status](https://travis-ci.org/athena-oss/plugin-gradle.svg?branch=master)](https://travis-ci.org/athena-oss/plugin-gradle)

This plugin allows you to execute gradle tasks in a configurable environment, reproduceable in different set-ups, such as: a development machine or a CI server. It also supports out of the box integration with an Android environment (e.g. Android Virtual Devices, etc); you can use it with local or remote devices.

To find out more about on how to manage Android devices using Athena refer to [Athena AVD Plugin](https://github.com/athena-oss/plugin-avd) or how to use Appium for running functional tests [Athena Appium Plugin](https://github.com/athena-oss/plugin-appium) for Android projects.

**HINT:** With this plugin you can use tools such as [Espresso](https://developer.android.com/training/testing/ui-testing/index.html) and [Robotium](http://www.robotium.org).

## How to Install ?

To install run the following command:

```bash
$ athena plugins install gradle https://github.com/athena-oss/plugin-gradle.git
```

### On MAC OSX Use [Homebrew](http://brew.sh/):

```bash
$ brew tap athena-oss/tap
$ brew install plugin-gradle
```

Read the [Documentation](http://athena-oss.github.io/plugin-gradle) on using Athena.

## How to Use ?

This plugin provides the following commands :

### cleanup - Cleanup all caches generated by the plugin

```bash
$ athena gradle cleanup
```

### exec - Execute a gradle task

```bash
$ athena gradle exec <project_dir> [<opts>...] [<tasks>...]

$ # e.g. execute unit tests
$ athena gradle exec my-project/ runUnitTests

$ # e.g. execute functional tests
$ athena gradle exec my-project/ runAndroidUITests --athena-env=my-android.env --with-avd=192.168.99.101:5555
```
## Contributing

Checkout our guidelines on how to contribute in [CONTRIBUTING.md](CONTRIBUTING.md).

## Versioning

Releases are managed using github's release feature. We use [Semantic Versioning](http://semver.org) for all
the releases. Every change made to the code base will be referred to in the release notes (except for
cleanups and refactorings).

## License

Licensed under the [Apache License Version 2.0 (APLv2)](LICENSE).
Loading

0 comments on commit c071c51

Please sign in to comment.