Reporters API #8

Activity

1. jgebal commented on Aug 31, 2017

   

   jgebal

   on Aug 31, 2017

   Last edited by jgebal

   Member

   More actions

   For now I would just say:
   Client supports any custom reporter that does not need any parameters

   This way we make that feature smaller and still of a great value.
2. jgebal

   added

   ready

   on Aug 31, 2017
3. rponte commented on Nov 23, 2017

   

   rponte

   on Nov 23, 2017

   More actions

   Hi guys, you have made a great job! Congrats!

   But I'd like to know if I can use a kind of Reporter API, if there is one, so that I can gather all results from utPLSQL's reporter. Nowadays I'm testing all PLSQL code through a test suite written in Java with jUnit, so I'm looking for an API like this:

   @Test
   public void shouldFindAProductByName() {
   
       reporterApi.startGathering(); // starts reporter to gather code coverage
   
       Product p = productDao.findByName("iPad"); // exercises PLSQL code here
       assertEquals(2020, p.getId());
   
       reporterApi.endGathering(); // ends reporter 
       System.out.println(reporterApi.printResults()); // shows results later or when needed
   }

   Of course this could be put into a jUnit Rule or even in @Before and @After methods. Is it possible to do something like this already?
4. jgebal commented on Nov 24, 2017

   

   jgebal

   on Nov 24, 2017

   Member

   More actions

   Hi @rponte
   With utPLSQL all the framework logic resides in DB and java-api is just an API for the framework.

   I think that the framework should be wrapping the tests and tests should not be referencing framework capabilities (like reporting).
   I don't fully follow what you want to achieve.

   Do you want to use JUnit tests with utPLSQL reporters?
5. rponte commented on Nov 24, 2017

   

   rponte

   on Nov 24, 2017

   Last edited by rponte

   More actions

   Hi @jgebal,

   Yeah! Just to be clear, this is exactly what I want: generate reports using utPLSQL from my jUnit tests.

   The idea of a code coverage reporter is gathering the coverage of a code exercised in specific context/session/scenario. In the case of utPSQL reporter, it could gather the code coverage of procedures executed in a session, regardless of whether this procedure was executed by utPLSQL, or jUnit+JDBC or even by an anonymous block via SQL Developer IDE.

   What I'm looking for and expecting from utPLSQL is a reporter API like this:

   declare
       l_html_report    varchar2(4000);
       ut_reporter      Ut_Reporter_API;
   begin
       ut_reporter := new Ut_Reporter_API();
       ut_reporter.startGathering(config=>'...'); // starts reporter to gather code coverage
   
       my_pkg.do_something('foo'); // exercises PLSQL code here
   
       ut_reporter.endGathering(); // ends reporter 
   
       l_html_report := ut_reporter.get_result(type => 'html'); // generates results
   end;

   Do you understand?

   I know I need to install utPLSQL in my database, there's no issue with this. But I'd like to use only its Reporter API from any session.

   If there's one way to do that with utPLSQL and you guide me through it I can do a pull request improving this Java API. What do you think?
6. jgebal commented on Nov 24, 2017

   

   jgebal

   on Nov 24, 2017

   Last edited by jgebal

   Member

   More actions

   This is something that is already available in DB API.
   If you have a look at how our self-testing script used to work - this is what it does (in simplified form):

   begin
     ut_coverage.coverage_start();
   end;
   /
   
   ------------------------------
   -----your stuff goes here
   ------------------------------
   
   prompt Generating coverage data to reporter outputs
   
   var html_reporter_id varchar2(32);
   
   declare
     v_reporter        ut_reporter_base;
   begin
     v_reporter := ut_coverage_html_reporter();
     :html_reporter_id := v_reporter.reporter_id;
     --generate coverage report
     v_reporter.after_calling_run(null);
   end;
   /
   
   set termout on
   prompt Spooling outcomes to coverage.html
   set termout off
   spool coverage.html
   
   exec ut_output_buffer.lines_to_dbms_output(:html_reporter_id);
   -- or 
   --select * from table(ut_output_buffer.get_lines(:html_reporter_id));
   
   spool off
   exit

   We used this approach for self-testing and reporting code coverage for a while (until we started using client).

   I would like to avoid putting this API into Java if it is only to satisfy external testing.

   In utPLSQL, it's not the reporter that starts the coverage, it's the RUN.
   This is because you may want to execute single run with multiple reporters, coverage should be started only once in that case.
7. pesse commented on Mar 20, 2018

   

   pesse

   on Mar 20, 2018

   Member

   More actions

   closed by #45
8. pesse

   closed this as completedon Mar 20, 2018