Verify Install

[Jan Lehnardt <ja...@apache.org>]

Hi All,

I'm trying to make the CouchDB first run experience a little smoother, 
here's what I got today:

A common first-run scenario is:

1. Install CouchDB
2. Run the test suite to verify your installation
3. Profit.

Step 2. can prove tricky. The Futon Test Suite isn't really designed to
"verify an installation". It is designed to fully exercise the HTTP API
and test some internal behaviour.

I propose to add a new menu item to Futon: "Verify Install" which links
to a page that has a minified test runner and includes a tiny subset of
the test suite, just enough to verify CouchDB works as expected.

To start, I limited the tests to creating a database, adding, updating
and deleting documents as well as exercising the JavaScript query
server by running a temporary view as well as a small local to local
replication. I'm sure there's a few more things we want to test, but
I wanted to get this out early.

Right now it just throws the JS exceptions, but I hope we can beef up
the mini runner to make sensible suggestions about what could be
wrong with an installation. Say the view query fails, we could point
users to resources on how to fix that.

The code lives here: http://github.com/janl/couchdb/tree/verify_installation

See the commit here: http://github.com/janl/couchdb/commit/5fdeb2beefb0fc9a7d3d2330cadd75fd337b03dc)

--

What do you think?

Cheers
Jan
-- 

Re: Verify Install

[Benoit Chesneau <bc...@gmail.com>]

On Fri, Oct 15, 2010 at 8:57 PM, Paul Davis <pa...@gmail.com> wrote:
> On Fri, Oct 15, 2010 at 2:50 PM, Jan Lehnardt <ja...@apache.org> wrote:
>> Hi All,
>>
>> I'm trying to make the CouchDB first run experience a little smoother,
>> here's what I got today:
>>
>> A common first-run scenario is:
>>
>> 1. Install CouchDB
>> 2. Run the test suite to verify your installation
>> 3. Profit.
>>
>> Step 2. can prove tricky. The Futon Test Suite isn't really designed to
>> "verify an installation". It is designed to fully exercise the HTTP API
>> and test some internal behaviour.
>>
>> I propose to add a new menu item to Futon: "Verify Install" which links
>> to a page that has a minified test runner and includes a tiny subset of
>> the test suite, just enough to verify CouchDB works as expected.
>>
>> To start, I limited the tests to creating a database, adding, updating
>> and deleting documents as well as exercising the JavaScript query
>> server by running a temporary view as well as a small local to local
>> replication. I'm sure there's a few more things we want to test, but
>> I wanted to get this out early.
>>
>> Right now it just throws the JS exceptions, but I hope we can beef up
>> the mini runner to make sensible suggestions about what could be
>> wrong with an installation. Say the view query fails, we could point
>> users to resources on how to fix that.
>>
>> The code lives here: http://github.com/janl/couchdb/tree/verify_installation
>>
>> See the commit here: http://github.com/janl/couchdb/commit/5fdeb2beefb0fc9a7d3d2330cadd75fd337b03dc)
>>
>> --
>>
>> What do you think?
>>
>> Cheers
>> Jan
>> --
>>
>>
>
> I think this is definitely a good idea. So much so that I think we
> should consider replacing the entire Futon test suite with something
> like this. Tests in Futon that are asserting core functionality should
> be part of the build system test suite.
>
> Paul Davis
>

imo alll the tests should be done on the "make check" with maybe a
couchdb -verify-install command.

The argument that futon test suite should exists because it is a good
place is just a social hack for me. We should better improve the doc.
Something that could be eventually downloaded and distributed with the
source.

- benoit

Re: Verify Install

[Mikeal Rogers <mi...@gmail.com>]

One of the things I'll eventually add to the new futon is a "diagnostics"
page.

This *should* take over for the test suite on the right sidebar. The test
suite will be somewhere else linked on that page and won't be for people who
aren't developing *on* CouchDB.

At least that's the idea. Big changes like this have to go through the list
which is why it's not part of my initial merge.

-Mikeal

On Fri, Oct 15, 2010 at 12:30 PM, Randall Leeds <ra...@gmail.com>wrote:

> On Fri, Oct 15, 2010 at 11:57, Paul Davis <pa...@gmail.com>
> wrote:
> > On Fri, Oct 15, 2010 at 2:50 PM, Jan Lehnardt <ja...@apache.org> wrote:
> >> Hi All,
> >>
> >> I'm trying to make the CouchDB first run experience a little smoother,
> >> here's what I got today:
> >>
> >> A common first-run scenario is:
> >>
> >> 1. Install CouchDB
> >> 2. Run the test suite to verify your installation
> >> 3. Profit.
> >>
> >> Step 2. can prove tricky. The Futon Test Suite isn't really designed to
> >> "verify an installation". It is designed to fully exercise the HTTP API
> >> and test some internal behaviour.
> >>
> >> I propose to add a new menu item to Futon: "Verify Install" which links
> >> to a page that has a minified test runner and includes a tiny subset of
> >> the test suite, just enough to verify CouchDB works as expected.
> >>
> >> To start, I limited the tests to creating a database, adding, updating
> >> and deleting documents as well as exercising the JavaScript query
> >> server by running a temporary view as well as a small local to local
> >> replication. I'm sure there's a few more things we want to test, but
> >> I wanted to get this out early.
> >>
> >> Right now it just throws the JS exceptions, but I hope we can beef up
> >> the mini runner to make sensible suggestions about what could be
> >> wrong with an installation. Say the view query fails, we could point
> >> users to resources on how to fix that.
> >>
> >> The code lives here:
> http://github.com/janl/couchdb/tree/verify_installation
> >>
> >> See the commit here:
> http://github.com/janl/couchdb/commit/5fdeb2beefb0fc9a7d3d2330cadd75fd337b03dc
> )
> >>
> >> --
> >>
> >> What do you think?
> >>
> >> Cheers
> >> Jan
> >> --
> >>
> >>
> >
> > I think this is definitely a good idea. So much so that I think we
> > should consider replacing the entire Futon test suite with something
> > like this. Tests in Futon that are asserting core functionality should
> > be part of the build system test suite.
> >
> > Paul Davis
> >
>
> +1 - That's a really good observation.
>

Re: Verify Install

[Randall Leeds <ra...@gmail.com>]

On Fri, Oct 15, 2010 at 11:57, Paul Davis <pa...@gmail.com> wrote:
> On Fri, Oct 15, 2010 at 2:50 PM, Jan Lehnardt <ja...@apache.org> wrote:
>> Hi All,
>>
>> I'm trying to make the CouchDB first run experience a little smoother,
>> here's what I got today:
>>
>> A common first-run scenario is:
>>
>> 1. Install CouchDB
>> 2. Run the test suite to verify your installation
>> 3. Profit.
>>
>> Step 2. can prove tricky. The Futon Test Suite isn't really designed to
>> "verify an installation". It is designed to fully exercise the HTTP API
>> and test some internal behaviour.
>>
>> I propose to add a new menu item to Futon: "Verify Install" which links
>> to a page that has a minified test runner and includes a tiny subset of
>> the test suite, just enough to verify CouchDB works as expected.
>>
>> To start, I limited the tests to creating a database, adding, updating
>> and deleting documents as well as exercising the JavaScript query
>> server by running a temporary view as well as a small local to local
>> replication. I'm sure there's a few more things we want to test, but
>> I wanted to get this out early.
>>
>> Right now it just throws the JS exceptions, but I hope we can beef up
>> the mini runner to make sensible suggestions about what could be
>> wrong with an installation. Say the view query fails, we could point
>> users to resources on how to fix that.
>>
>> The code lives here: http://github.com/janl/couchdb/tree/verify_installation
>>
>> See the commit here: http://github.com/janl/couchdb/commit/5fdeb2beefb0fc9a7d3d2330cadd75fd337b03dc)
>>
>> --
>>
>> What do you think?
>>
>> Cheers
>> Jan
>> --
>>
>>
>
> I think this is definitely a good idea. So much so that I think we
> should consider replacing the entire Futon test suite with something
> like this. Tests in Futon that are asserting core functionality should
> be part of the build system test suite.
>
> Paul Davis
>

+1 - That's a really good observation.

Re: Verify Install

[Paul Davis <pa...@gmail.com>]

On Fri, Oct 15, 2010 at 2:50 PM, Jan Lehnardt <ja...@apache.org> wrote:
> Hi All,
>
> I'm trying to make the CouchDB first run experience a little smoother,
> here's what I got today:
>
> A common first-run scenario is:
>
> 1. Install CouchDB
> 2. Run the test suite to verify your installation
> 3. Profit.
>
> Step 2. can prove tricky. The Futon Test Suite isn't really designed to
> "verify an installation". It is designed to fully exercise the HTTP API
> and test some internal behaviour.
>
> I propose to add a new menu item to Futon: "Verify Install" which links
> to a page that has a minified test runner and includes a tiny subset of
> the test suite, just enough to verify CouchDB works as expected.
>
> To start, I limited the tests to creating a database, adding, updating
> and deleting documents as well as exercising the JavaScript query
> server by running a temporary view as well as a small local to local
> replication. I'm sure there's a few more things we want to test, but
> I wanted to get this out early.
>
> Right now it just throws the JS exceptions, but I hope we can beef up
> the mini runner to make sensible suggestions about what could be
> wrong with an installation. Say the view query fails, we could point
> users to resources on how to fix that.
>
> The code lives here: http://github.com/janl/couchdb/tree/verify_installation
>
> See the commit here: http://github.com/janl/couchdb/commit/5fdeb2beefb0fc9a7d3d2330cadd75fd337b03dc)
>
> --
>
> What do you think?
>
> Cheers
> Jan
> --
>
>

I think this is definitely a good idea. So much so that I think we
should consider replacing the entire Futon test suite with something
like this. Tests in Futon that are asserting core functionality should
be part of the build system test suite.

Paul Davis