Skip to content

Commit

Permalink
Merge pull request #211 from openstf/v.1.1.0-release
Browse files Browse the repository at this point in the history
v1.1.0 release
  • Loading branch information
vbanthia committed Jan 4, 2016
2 parents 7dc2eda + d656b7b commit 35e43d4
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 7 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## CHANGES IN VERSION 1.1 (from 1.0.10)

Minor release addressing the following:

### Enhancements
- Android 6.0 support
- Added translation support for Chinese, Korean, Russian and Spanish
- Added File Explorer feature in device controller where you can access device file system
- Added optional storage-s3 unit which can store storage data in Amazon S3 bucket instead of local
- Now, "Notes" column of device list is editable.
- Experimental armv7l support
- Added [stf-setup-examples](https://github.com/openstf/setup-examples) using [Vagrant](https://www.vagrantup.com/) and [Virtual Box](https://www.virtualbox.org/)

### Fixes
- [DEPLOYMENT doc ](https://github.com/openstf/stf/blob/master/doc/DEPLOYMENT.md) fixes
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ It is currently being used at [CyberAgent](https://www.cyberagent.co.jp/en/) to
* OS support
- Android
* Supports versions 2.3.3 (SDK level 10) to 6.0 (SDK level 23)
- **Note: build from master for 6.0 support until 1.1.0 is out.**
* Supports Wear 5.1 (but not 5.0 due to missing permissions)
* Supports Fire OS, CyanogenMod, and other heavily Android based distributions
* `root` is **not** required for any current functionality
Expand All @@ -44,6 +43,7 @@ It is currently being used at [CyberAgent](https://www.cyberagent.co.jp/en/) to
* Run any `adb` command locally, including shell access
* [Android Studio](http://developer.android.com/tools/studio/index.html) and other IDE support, debug your app while watching the device screen on your browser
* Supports [Chrome remote debug tools](https://developer.chrome.com/devtools/docs/remote-debugging)
- File Explorer to access device file system
- Experimental VNC support (work in progress)
* Manage your device inventory
- See which devices are connected, offline/unavailable (indicating a weak USB connection), unauthorized or unplugged
Expand All @@ -66,10 +66,9 @@ We're also actively working to expand the team. Welcome **@vbanthia** as our new
Here are some things we are planning to address ASAP.

1. Properly expose the new VNC functionality in the UI
2. Release 1.1.0 so that we have stable version with Android 6.0 support
3. Implement a basic REST API for programmatically using devices
4. Properly reset user data between uses (Android 4.0+)
5. Automated scheduled restarts for devices
2. Implement a basic REST API for programmatically using devices
3. Properly reset user data between uses (Android 4.0+)
4. Automated scheduled restarts for devices

### Sponsors wanted

Expand All @@ -91,7 +90,7 @@ As the product has evolved from an internal tool running in our internal network

* [Node.js](https://nodejs.org/) >= 0.12
* [ADB](http://developer.android.com/tools/help/adb.html) properly set up
* [RethinkDB](http://rethinkdb.com/) >= 2.0.0
* [RethinkDB](http://rethinkdb.com/) >= 2.2
* [GraphicsMagick](http://www.graphicsmagick.org/) (for resizing screenshots)
* [ZeroMQ](http://zeromq.org/) libraries installed
* [Protocol Buffers](https://github.com/google/protobuf) libraries installed
Expand Down
32 changes: 32 additions & 0 deletions doc/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,38 @@ ExecStart=/usr/bin/docker run --rm \
ExecStop=-/usr/bin/docker stop -t 10 %p
```

### `[email protected]`

If you want to store data such as screenshots and apk files into [Amazon S3](https://aws.amazon.com/s3/) instead of locally, then you can use this optional unit. Before using this you will need to setup your amazon account and get proper credentials for S3 bucket. You can read more about this at [AWS documentation](https://aws.amazon.com/s3/).

** NOTE** If you are using this storage, you will not need [[email protected]](#stf-storage-tempservice) unit, since both do the same thing. Only the storage location is different.

This is a template unit, meaning that you'll need to start it with an instance identifier. In this example configuration the identifier is used to specify the exposed port number (i.e. `[email protected]` runs on port 3500). Currently, **you cannot have more than one instance of this unit**, as both temporary files and an in-memory mapping is used. Using a template unit makes it easy to set the port.

```ini
[Unit]
Description=STF s3 storage
After=docker.service
Requires=docker.service

[Service]
EnvironmentFile=/etc/environment
TimeoutStartSec=0
Restart=always
ExecStartPre=/usr/bin/docker pull openstf/stf:latest
ExecStartPre=-/usr/bin/docker kill %p-%i
ExecStartPre=-/usr/bin/docker rm %p-%i
ExecStart=/usr/bin/docker run --rm \
--name %p-%i \
-p %i:3000 \
openstf/stf:latest \
stf storage-s3 --port 3000 \
--bucket YOUR_S3_BUCKET_NAME_HERE \
--profile YOUR_AWS_CREDENTIALS_PROFILE \
--endpoint YOUR_BUCKET_ENDPOING_HERE
ExecStop=-/usr/bin/docker stop -t 10 %p-%i
```

## Nginx configuration

Now that you've got all the units ready, it's time to set up [nginx](http://nginx.org/) to tie all the processes together with a clean URL.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stf",
"version": "1.0.10",
"version": "1.1.0",
"description": "Smartphone Test Farm",
"keywords": [
"adb",
Expand Down

0 comments on commit 35e43d4

Please sign in to comment.