From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nathan Neff Subject: Re: [babel] Babel as a test harness? Date: Sat, 20 Mar 2010 14:22:14 -0500 Message-ID: <211769421003201222w571e62ecr6efa343dc48439cc@mail.gmail.com> References: <211769421003191643l2d00b8cai63028b369408552f@mail.gmail.com> <874okblt2p.fsf@stats.ox.ac.uk> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0324145783==" Return-path: Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Nt4FY-0007wY-Fv for emacs-orgmode@gnu.org; Sat, 20 Mar 2010 15:22:20 -0400 Received: from [140.186.70.92] (port=56322 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Nt4FV-0007wQ-Mn for emacs-orgmode@gnu.org; Sat, 20 Mar 2010 15:22:19 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1Nt4FT-0005wj-RR for emacs-orgmode@gnu.org; Sat, 20 Mar 2010 15:22:17 -0400 Received: from mail-yx0-f172.google.com ([209.85.210.172]:40281) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Nt4FT-0005wd-NN for emacs-orgmode@gnu.org; Sat, 20 Mar 2010 15:22:15 -0400 Received: by yxe2 with SMTP id 2so1752987yxe.14 for ; Sat, 20 Mar 2010 12:22:14 -0700 (PDT) In-Reply-To: <874okblt2p.fsf@stats.ox.ac.uk> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Dan Davison Cc: emacs-orgmode@gnu.org --===============0324145783== Content-Type: multipart/alternative; boundary=000e0cd70de6a3edbb0482406149 --000e0cd70de6a3edbb0482406149 Content-Type: text/plain; charset=ISO-8859-1 On Fri, Mar 19, 2010 at 7:45 PM, Dan Davison wrote: > Nathan Neff writes: > > > I think it would be cool to use Org-babel as a simple test harness. > > > > I'd like to have an org file, with various sections that demonstrate how > to do > > something in Groovy. I'd like to be able to run all the code in the org > file > > and make sure > > they all run successfully (return code 0). > > > > In Groovy, the "assert" function will exit with a non-zero code if it > fails. > > How > > would I use org-babel to generate a "summary" table with the name of > > each patch of code and whether or not it succeeded? > > Like below? This is all Eric's doing. For quite a while now org-babel > has used a table like this to validate itself. It took me a while to > understand it, but basically Eric designed a special function (actually, > a macro) called sbe (source block evaluate) to be used in table formulas > to call org-babel source blocks. Use C-u C-c C-c to update the table. > > * Tests > | functionality | block | arg | expected | results | > pass | > > |----------------+--------------+-----+----------+----------------------+--------------------------------------------| > | simple regexp | simple_regex | | | | > pass | > | regexp with or | regex_or | | | A pretend problem... | > expected "" but was "A pretend problem..." | > #+TBLFM: $5='(if (= (length $3) 1) (sbe $2 (n $3)) (sbe $2)) :: $6='(if > (string= $4 $5) "pass" (format "expected %S but was %S" $4 $5)) > > * Code blocks for tests > ** Here's how to match "foo" > #+source: simple_regex > #+begin_src groovy > assert "foo" =~ /foo/ > #+end_src > > ** Here's how to match "bar" or "baz" > #+source: regex_or > #+begin_src groovy > assert "bar" =~ "ba(z|r)" > println "A pretend problem" > #+end_src > > This is awesome. I tried it and it works. The table's "results" column says exactly what went wrong. For example, if I have the following: ** Here's how to match "bar" or "baz" #+source: regex_or #+begin_src groovy assert "bar" =~ "this ain't gonna match" #+end_src Then, my results table looks like this: | results | | Caught: java.lang.AssertionError: Expression: (bar =~ this ain't gonna | really cool! --Nate > You can put any arguments to your source blocks in the arg column. See > > http://orgmode.org/worg/org-contrib/babel/intro.php#spreadsheet > > (It often makes most sense to clone Worg and view the org files > themseleves) > > And for a more complex example, including how to pass arguments to > source blocks to sbe, see our full test suite in the file > development.org in the devel repo > > http://github.com/eschulte/babel-dev/ > > Dan > > p.s. groovy seems to be funny about hyphens in the input file name. I > think you want to apply this: > > diff --git a/contrib/babel/lisp/langs/org-babel-groovy.el > b/contrib/babel/lisp/langs/org-babel-groovy.el > index 02b3272..d6a28a7 100644 > --- a/contrib/babel/lisp/langs/org-babel-groovy.el > +++ b/contrib/babel/lisp/langs/org-babel-groovy.el > @@ -88,7 +88,7 @@ print o join(\"\\n\", @r), \"\\n\"") > (defun org-babel-groovy-evaluate (session body &optional result-type) > "Evaluate Groovy code in BODY" > ;; external process evaluation > - (let ((infile (make-temp-file "org_babel_groovy_input_"))) > + (let ((infile (replace-regexp-in-string "-" "_" (make-temp-file > "org_babel_groovy_input_")))) > (save-excursion > (with-temp-buffer > (with-temp-file infile (insert body)) > > > > > > > Something like this would be cool: > > > > * Regular Expressions > > ** Here's how to match "foo" > > > > #+source simple_regex > > #+begin_src groovy > > assert "foo" =~ /foo/ > > #+end_src > > > > ** Here's how to match "bar" or "baz" > > #+source regex_or > > #+begin_src groovy > > assert "bar" =~ "ba(z|r)" > > #+end_src > > > > * Results: > > | simple_regex | success | > > | regex_or | success | > > > > _______________________________________________ > > Emacs-orgmode mailing list > > Please use `Reply All' to send replies to the list. > > Emacs-orgmode@gnu.org > > http://lists.gnu.org/mailman/listinfo/emacs-orgmode > --000e0cd70de6a3edbb0482406149 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable

On Fri, Mar 19, 2010 at 7:45 PM, Dan Dav= ison <daviso= n@stats.ox.ac.uk> wrote:
Nathan Neff <= nathan.neff@gmail.com> writes:

> I think it would be cool to use Org-babel as a simple test harness. >
> I'd like to have an org file, with various sections that demonstra= te how to do
> something in Groovy.=A0 I'd like to be able to run all the code in= the org file
> and make sure
> they all run successfully (return code 0).
>
> In Groovy, the "assert" function will exit with a non-zero c= ode if it fails.=A0
> How
> would I use org-babel to generate a "summary" table with the= name of
> each patch of code and whether or not it succeeded?

Like below? This is all Eric's doing. For quite a while now org-b= abel
has used a table like this to validate itself. It took me a while to
understand it, but basically Eric designed a special function (actually, a macro) called sbe (source block evaluate) to be used in table formulas to call org-babel source blocks. Use C-u C-c C-c to update the table.

* Tests
| functionality =A0| block =A0 =A0 =A0 =A0| arg | expected | results =A0 = =A0 =A0 =A0 =A0 =A0 =A0| pass =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 = =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 |
|----------------+--------------+-----+----------+----------------------+--= ------------------------------------------|
| simple regexp =A0| simple_regex | =A0 =A0 | =A0 =A0 =A0 =A0 =A0| =A0 =A0 = =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0| pass =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 = =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 |
| regexp with or | regex_or =A0 =A0 | =A0 =A0 | =A0 =A0 =A0 =A0 =A0| A pret= end problem... | expected "" but was "A pretend problem...&q= uot; |
#+TBLFM: $5=3D'(if (=3D (length $3) 1) (sbe $2 (n $3)) (sbe $2)) :: $6= =3D'(if (string=3D $4 $5) "pass" (format "expected %S bu= t was %S" $4 $5))

* Code blocks for tests
** Here's how to match "foo"
#+source: simple_regex
#+begin_src groovy
assert "foo" =3D~ /foo/
#+end_src

** Here's how to match "bar" or "baz"
#+source: regex_or
#+begin_src groovy
assert "bar" =3D~ "ba(z|r)"
println "A pretend problem"
#+end_src


This is awesome.=A0 I tried it and it works.
<= br>The table's "results" column says exactly what went wrong.=
For example, if I have the following:

** Here's how to match= "bar" or "baz"
#+source: regex_or
#+begin_src groovy
assert "bar" =3D~ "this ain't gonna match"
#+end_src

Then, my results table looks like this:
| results |
= | Caught: java.lang.AssertionError: Expression: (bar =3D~ this ain't go= nna |

really cool!

--Nate
=A0
You can put any arguments to your source blocks in the arg column. See

http://orgmode.org/worg/org-contrib/babel/intro.php#spre= adsheet

(It often makes most sense to clone Worg and view the org files
themseleves)

And for a more complex example, including how to pass arguments to
source blocks to sbe, see our full test suite in the file
development.org in= the devel repo

http://= github.com/eschulte/babel-dev/

Dan

p.s. groovy seems to be funny about hyphens in the input file name. I
think you want to apply this:

diff --git a/contrib/babel/lisp/langs/org-babel-groovy.el b/contrib/babel/l= isp/langs/org-babel-groovy.el
index 02b3272..d6a28a7 100644
--- a/contrib/babel/lisp/langs/org-babel-groovy.el
+++ b/contrib/babel/lisp/langs/org-babel-groovy.el
@@ -88,7 +88,7 @@ print o join(\"\\n\", @r), \"\\n\"&qu= ot;)
=A0(defun org-babel-groovy-evaluate (session body &optional result-type= )
=A0 "Evaluate Groovy code in BODY"
=A0;; external process evaluation
- (let ((infile (make-temp-file "org_babel_groovy_input_")))
+ =A0(let ((infile (replace-regexp-in-string "-" "_" (m= ake-temp-file "org_babel_groovy_input_"))))
=A0 =A0(save-excursion
=A0 =A0 =A0(with-temp-buffer
=A0 =A0 =A0 =A0(with-temp-file infile (insert body))



>
> Something like this would be cool:
>
> * Regular Expressions
> ** Here's how to match "foo"
>
> #+source simple_regex
> #+begin_src groovy
> assert "foo" =3D~ /foo/
> #+end_src
>
> ** Here's how to match "bar" or "baz"
> #+source regex_or
> #+begin_src groovy
> assert "bar" =3D~ "ba(z|r)"
> #+end_src
>
> * Results:
> | simple_regex | success |
> | regex_or=A0=A0=A0=A0=A0=A0=A0 | success |
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

--000e0cd70de6a3edbb0482406149-- --===============0324145783== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Emacs-orgmode mailing list Please use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode --===============0324145783==--