Skip to content

Updated docs, added trivial tests #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ jobs:
script: ./tool/travis.sh dartanalyzer
env: PKG="webdev"
dart: dev
- stage: unit_test
script: ./tool/travis.sh test
env: PKG="webdev"
dart: dev

stages:
- analyzer_and_format
- unit_test

# Only building master means that we don't run two builds for each pull request.
branches:
Expand Down
5 changes: 5 additions & 0 deletions tool/travis.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ while (( "$#" )); do
echo -e 'dartfmt -n --set-exit-if-changed .'
dartfmt -n --set-exit-if-changed . || EXIT_CODE=$?
;;
test) echo
echo -e '\033[1mTASK: test\033[22m'
echo -e 'pub run test'
pub run test || EXIT_CODE=$?
;;
*) echo -e "\033[31mNot expecting TASK '${TASK}'. Error!\033[0m"
EXIT_CODE=1
;;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this our recommended approach to travis testing now? What happened to the days of just adding a few lines in the travis.yaml?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is using mono_repo – let's us test multiple packages in one repo easily...

Expand Down
4 changes: 2 additions & 2 deletions webdev/.mono_repo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ stages:
- analyzer_and_format:
- dartfmt
- dartanalyzer: --fatal-infos --fatal-warnings .
# - unit_test:
# - test
- unit_test:
- test
26 changes: 26 additions & 0 deletions webdev/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Copyright 2017, the Dart project authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 changes: 21 additions & 9 deletions webdev/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Experimental Usage
## Installation

The example directory contains a package that is configured to work with
`pub run webdev <command>`. Support for `pub global activate webdev` and simply
adding a dev_dependency to your packages is coming soon.
```console
$ pub global activate webdev
```

## Commands
## Usage

* __build__: Run builders to build a package.
* __help__: Display help information for webdev.
* __serve__: Run a local web development server and a file system watcher that
re-builds on changes.
```console
$ webdev
A tool to develop Dart web projects.

Usage: webdev <command> [arguments]

Global options:
-h, --help Print this usage information.

Available commands:
build Run builders to build a package.
help Display help information for webdev.
serve Run a local web development server and a file system watcher that re-builds on changes.

Run "webdev help <command>" for more information about a command.
```
4 changes: 4 additions & 0 deletions webdev/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,9 @@ dependencies:
io: ^0.3.2+1
stack_trace: ^1.9.2

dev_dependencies:
test: ^0.12.0
test_process: ^1.0.1

executables:
webdev:
39 changes: 39 additions & 0 deletions webdev/test/integration_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2018

// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:io';

import 'package:test/test.dart';
import 'package:test_process/test_process.dart';

void main() {
test('README contains help output', () async {
var process = await TestProcess.start('dart', ['bin/webdev.dart']);

var output = (await process.stdoutStream().join('\n')).trim();

var readme = new File('README.md');

expect(readme.readAsStringSync(),
contains('```console\n\$ webdev\n$output\n```'));

await process.shouldExit(0);
});

test('non-existant commands create errors', () async {
var process =
await TestProcess.start('dart', ['bin/webdev.dart', 'monkey']);

var output = (await process.stdoutStream().join('\n')).trim();

expect(output, contains('Could not find a command named "monkey".'));

await process.shouldExit(64);
});

test('should fail in a package without a build_runner dependency', () async {
var process = await TestProcess.start('dart', ['bin/webdev.dart', 'serve']);
await process.shouldExit(255);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we expecting anything other than a failure yet?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is running against itself – so no build_runner dep or anything. We expect it to always fail.

...although in the future it should fail with a more helpful message and a different error code

});
}