calabash / calabash-ios

Calabash for iOS
Other
1.81k stars 369 forks source link

Feature Request: Add documentation for running calabash-ios in a CI environment. #786

Open iMerica opened 9 years ago

iMerica commented 9 years ago

Hi,

This software is an open source tool to aid test automation of iOS applications. To that end, it would be helpful to have docs for how one might automate the running of Calabash-IOs tests in an open source CI server environment like Jenkins without interfacing with Xcode's GUI at all. Otherwise the automation lives only in a laptop, triggered manually in a terminal emulator (which isn't automation).

I'll be working on the task of running calabash tests in Jenkins this week, so I'll submit a PR with some docs once I've completed.

Thanks,

Michael

iMerica commented 9 years ago

I found this page in a Google search. Might want to link to it from your main README or from the wiki home page. It appears to be totally orphaned.

Update: The links in the doc are quite old and incomplete.

jmoody commented 9 years ago

Our policy is not to provide support docs for CI because we do not have time to keep them updated and CI is beyond the scope of the Calabash project.

On Wednesday, June 10, 2015, Michael Martinez notifications@github.com wrote:

I found this page https://github.com/calabash/calabash-ios/wiki/D1---CI,-Jenkins,-Code-Coverage in a Google search. Might want to link to it from your main README or from the wiki home page. It appears to be totally orphaned.

— Reply to this email directly or view it on GitHub https://github.com/calabash/calabash-ios/issues/786#issuecomment-110526475 .

jmoody commented 9 years ago

Whoops. Hit send too soon. I appreciate that you interested in helping with docs. Thanks!

On Wednesday, June 10, 2015, Joshua Moody joshuajmoody@gmail.com wrote:

Our policy is not to provide support docs for CI because we do not have time to keep them updated and CI is beyond the scope of the Calabash project.

On Wednesday, June 10, 2015, Michael Martinez <notifications@github.com javascript:_e(%7B%7D,'cvml','notifications@github.com');> wrote:

I found this page https://github.com/calabash/calabash-ios/wiki/D1---CI,-Jenkins,-Code-Coverage in a Google search. Might want to link to it from your main README or from the wiki home page. It appears to be totally orphaned.

— Reply to this email directly or view it on GitHub https://github.com/calabash/calabash-ios/issues/786#issuecomment-110526475 .

jmoody commented 9 years ago

Might want to link to it from your main README or from the wiki home page. It appears to be totally orphaned.

Is out of date. I think we should delete the entire page.

iMerica commented 9 years ago

Hi @jmoody,

Thanks for your reply. Should I bother submitting a PR for docs on running tests in Jenkins? I'm a little confused as to why CI can be out of scope for Calabash. That's the point of this automation isn't it? To have computers run the automated tests based on a schedule or event without any human intervention? I realize this project is sponsored by Xamarin, but it is open source - shouldn't it be capable of running in any open source CI environment in addition to Xamarin's Test Cloud?

Similarly, Appium is sponsored by Sauce Labs, yet they maintain docs for running Appium tests in Jenkins.

Kind regards,

Michael

jmoody commented 9 years ago

a PR

All the docs should be on the wiki. If you are suggesting a PR on the wiki, then yes, please submit one.

out of scope

Just to be clear, my opinion about trying to document Calabash running in CI has nothing to do with Xamarin.

Calabash is a BDD framework. You can use it in CI environments. Since there are more CI environments then we have time to use and understand, we've decided to not maintain documentation for any CI. We use Travis and Jenkins. The CI servers are public. If you want to see how we do it, one can look at the scripts or ask on the forum.

We don't have time to document how to stand up a Jenkins server on a MacOS machine.

If you follow the links to the Xamarin docs on the front page of the wiki I believe you will find CI docs. I would grab a link, but I am on my iPhone.

Does this answer your questions?

On Thursday, June 11, 2015, Michael Martinez notifications@github.com wrote:

Hi @jmoody https://github.com/jmoody,

Thanks for your reply. Should I bother submitting a PR for docs on running tests in Jenkins? I'm a little confused as to why CI can be out of scope for Calabash. That's the point of this automation isn't it? To have computers run the automated tests based on a schedule or event without any human intervention? I realize this project is sponsored by Xamarin, but it is open source - shouldn't it be capable of running in any open source CI environment in addition to Xamarin's Test Cloud?

Similarly, Appium is sponsored by Sauce Labs, yet they maintain docs for running Appium tests in Jenkins http://appium.io/slate/en/tutorial/ios.html?ruby#running-using-jenkins-ci.

Kind regards,

Michael

— Reply to this email directly or view it on GitHub https://github.com/calabash/calabash-ios/issues/786#issuecomment-111036189 .

jmoody commented 9 years ago

That's the point of this automation isn't it? To have computers run the automated tests based on a schedule or event without any human intervention?

Yes. That is the point of automation. But I don't think Calabash is about automation. Calabash is about BDD.

I am enjoying this exchange. It is challenging my assumptions.

On Thursday, June 11, 2015, Joshua Moody joshuajmoody@gmail.com wrote:

a PR

All the docs should be on the wiki. If you are suggesting a PR on the wiki, then yes, please submit one.

out of scope

Just to be clear, my opinion about trying to document Calabash running in CI has nothing to do with Xamarin.

Calabash is a BDD framework. You can use it in CI environments. Since there are more CI environments then we have time to use and understand, we've decided to not maintain documentation for any CI. We use Travis and Jenkins. The CI servers are public. If you want to see how we do it, one can look at the scripts or ask on the forum.

We don't have time to document how to stand up a Jenkins server on a MacOS machine.

If you follow the links to the Xamarin docs on the front page of the wiki I believe you will find CI docs. I would grab a link, but I am on my iPhone.

Does this answer your questions?

On Thursday, June 11, 2015, Michael Martinez <notifications@github.com javascript:_e(%7B%7D,'cvml','notifications@github.com');> wrote:

Hi @jmoody https://github.com/jmoody,

Thanks for your reply. Should I bother submitting a PR for docs on running tests in Jenkins? I'm a little confused as to why CI can be out of scope for Calabash. That's the point of this automation isn't it? To have computers run the automated tests based on a schedule or event without any human intervention? I realize this project is sponsored by Xamarin, but it is open source - shouldn't it be capable of running in any open source CI environment in addition to Xamarin's Test Cloud?

Similarly, Appium is sponsored by Sauce Labs, yet they maintain docs for running Appium tests in Jenkins http://appium.io/slate/en/tutorial/ios.html?ruby#running-using-jenkins-ci.

Kind regards,

Michael

— Reply to this email directly or view it on GitHub https://github.com/calabash/calabash-ios/issues/786#issuecomment-111036189 .

jmoody commented 9 years ago

@iMerica

I am back at my desk after a brief vacation. Does my argument against trying to document CI make sense?

I can imagine a document that describes best practices in CI.

I could not find the link to the Xamarin docs about CI. I will keep looking.

jmoody commented 9 years ago

@iMerica

Is out of date. I think we should delete the entire page.

I was too hasty. There is some good stuff there. I reviewed the content and renamed the page to make it easier to find.

https://github.com/calabash/calabash-ios/wiki/Continuous-Integration-and-Code-Coverage

If you have content to provide, we'd really appreciate it.

Thanks!