Docs: Protractor documentation

[angular]

Docs: Protractor documentation

[juliemr]

Define short-term? :)

I definitely definitely have this on my todo list, but it's not item 1.

[aaronleesmith]

How about I run protractor.js through a doc parser and see if we can get some semi-meaningful documentation out of it?

Would you recommend using protractor now even with 1.2 still on the horizon? I don't want to write all my e2e tests using karma + jasmine if the Angular team will be moving to protractor. (Not part of this issue, but need to ask)

[juliemr]

I'd definitely accept any doc generating!

Angular end2end tests will be moving to protractor, probably sometime in the next quarter. How are you writing e2e tests in jasmine at the moment? Or do you mean using the angular scenario runner?

Protractor is definitely still v0.X and has issues to iron out - but it's built on top of WebDriverJS, which is largely solidified. So, I think if you invest in tests in protractor you won't be wasting time. Depends on your tolerance for a couple quirks.

[aaronleesmith]

EDIT: I realize the below question is addressed in issue #21 . I will leave here in case someone else runs across the issue.

I don't mind the quirks, since selenium webdriver is what our QA team is used to.

Your code doesn't lend itself precisely to any auto doc-generating framework, but I think it could easily be coerced into it. I'll take a look and possibly set this up for me and anyone else ready to make the switch to protractor.

A quick question: is there a way to wait until angular is done bootstrapping (ng-clock would be satisfied) to start running tests. My spec looks like this:

describe('app', function() {
  var ptor;
  ptor = protractor.getInstance()

  beforeEach(function() {
    ptor.get('webapp/app/index.html#/home')
  })

  it('should load the home page', function() {
    body = ptor.findElement(protractor.By.tagName('body'));
    body.isDisplayed().then(function() {
      expect(body).toBeDefined()
    })
  })
})

And when run I get:

Finished in 0.007 seconds
1 test, 0 assertions, 0 failures

So it worked, but it never got a chance to run that expect() statement. Any idea what's going on?

I'm sure I'm just doing something simple incorrectly, but there's no docs to help solve it :)

I've forked the project and will look into generating docs.

[juliemr]

Some auto-generation is now done, see https://github.com/angular/protractor/blob/master/docs/api.md

It's super hacky and still could be improved a ton.

[juliemr]

I think this issue is broad enough that it's no longer useful. I'm gonna close - please open new issues for specific documentation questions!