emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Eric Schulte <schulte.eric@gmail.com>
To: Jambunathan K <kjambunathan@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [RFC] testing the org exporters
Date: Fri, 01 Jul 2011 13:08:42 -0700	[thread overview]
Message-ID: <87k4c1lpx9.fsf@gmail.com> (raw)
In-Reply-To: 81iprmxk5x.fsf@gmail.com

Jambunathan K <kjambunathan@gmail.com> writes:

> I have been using the attached test.org file as part of my org-odt
> related work.
>
> The usual steps I follow for testing are quite simple:
> 1. Visit the file
> 2. Export it to xhtml or odt
> 3. Visually make sure that everything is OK.
>
> I would like to add this file to the testing dir of the trunk. This file
> would be a good starting point for not only validating but also
> documenting (the quirks?) of various exporters.
>
> At the moment, I am not very inclined to have it integrated with
> ert[1]. Based on my experience, the standalone test.org file has proven
> it's worth multiple times over during the development phase.
>
> What do you think? I am happy to hear feedback on 
>
> 1. what to put in that test.org 
> 2. where to put the test.org 
> 3. how to have it integrated with test framework.
>
> Footnotes: 
> [1]  This is mostly because I don't know nothing about ert.

Hi Jambunathan,

I would very much like to see this test file [1] integrated into the testing
repository of org-mode in (testing/examples) _and_ integrated into
Org-mode's ert test framework.

ERT is easy to use, and will more than repay any time spent applying it
to your test file through the ability to quickly programmatically and
reproducibly evaluate export results.  There are many tests [2] which
already implement a
1. visit example file
2. export to backend
3. confirm properties of backend (e.g., does or does not contain some string)

Please try running the Org-mode test suite and look at the examples in
testing/lisp.  I see no reason not to take this final step and begin
writing ERT tests which can serve as both documentation of issues and
insurance against regression.

Best -- Eric

Footnotes: 
[1]  I am not sure about including the org-mode unicorn png image in the
     repository as that could add alot of weight... perhaps .gitignore
     that file, point to a version of the file online, or generate an
     image on the fly with ditaa as part of the test suite

[2]  for example those in testing/lisp/test-ob-exp.el

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/

next prev parent reply	other threads:[~2011-07-01 20:14 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-07-01 12:25 [RFC] testing the org exporters Jambunathan K
2011-07-01 20:08 ` Eric Schulte [this message]
2011-07-04  9:39   ` Martyn Jago

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87k4c1lpx9.fsf@gmail.com \
    --to=schulte.eric@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=kjambunathan@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).