Fi 2962 execute outputters #541

Shaumik-Ashraf · 2024-10-08T21:08:46Z

Summary

To inferno execute add:

--outputter option that defaults to console
new spinner on console outputter
a plain text outputter (no colors or spinner)
a quiet outputter (no output)
a json outputter, which should copy Inferno's REST API results endpoints.

JSON Output format (for dev_validator suite):

[
  {
    "id": "c2c564ec-1a4d-4c5e-a90f-692133a45e5c",
    "created_at": "2024-10-08T17:08:18.764-04:00",
    "inputs": [
      {
        "name": "url",
        "label": "FHIR Server Base Url",
        "description": null,
        "value": "https://hapi.fhir.org/baseR4",
        "type": "text"
      },
      {
        "name": "access_token",
        "label": "Bearer/Access Token",
        "description": null,
        "value": null,
        "type": "text"
      },
      {
        "name": "patient_id",
        "label": "Patient ID",
        "description": null,
        "value": "1234321",
        "type": "text"
      }
    ],
    "optional": false,
    "outputs": [

    ],
    "requests": [

    ],
    "result": "pass",
    "test_run_id": "92302803-1f13-46ef-a66e-793a92ac5fd1",
    "test_session_id": "cG9laeggvmM",
    "test_suite_id": "dev_validator",
    "updated_at": "2024-10-08T17:08:18.764-04:00"
  },
  {
    "id": "482d9df5-9941-4e46-a302-ae441ea47889",
    "created_at": "2024-10-08T17:08:18.763-04:00",
    "inputs": [

    ],
    "optional": false,
    "outputs": [

    ],
    "requests": [

    ],
    "result": "pass",
    "test_run_id": "92302803-1f13-46ef-a66e-793a92ac5fd1",
    "test_session_id": "cG9laeggvmM",
    "test_suite_id": "dev_validator",
    "updated_at": "2024-10-08T17:08:18.763-04:00"
  },
  {
    "id": "70f3b03b-0d72-4150-9129-d46231d48558",
    "created_at": "2024-10-08T17:08:18.760-04:00",
    "inputs": [
      {
        "name": "url",
        "label": "FHIR Server Base Url",
        "description": null,
        "value": "https://hapi.fhir.org/baseR4",
        "type": "text"
      },
      {
        "name": "access_token",
        "label": "Bearer/Access Token",
        "description": null,
        "value": null,
        "type": "text"
      },
      {
        "name": "patient_id",
        "label": "Patient ID",
        "description": null,
        "value": "1234321",
        "type": "text"
      }
    ],
    "optional": false,
    "outputs": [

    ],
    "requests": [

    ],
    "result": "pass",
    "test_group_id": "dev_validator-patient_group",
    "test_run_id": "92302803-1f13-46ef-a66e-793a92ac5fd1",
    "test_session_id": "cG9laeggvmM",
    "updated_at": "2024-10-08T17:08:18.760-04:00"
  },
  {
    "id": "6c6b4a39-5a1e-4035-92f1-3ee41c7fd18d",
    "created_at": "2024-10-08T17:08:18.757-04:00",
    "inputs": [
      {
        "name": "url",
        "value": "https://hapi.fhir.org/baseR4",
        "type": "text"
      },
      {
        "name": "access_token",
        "value": null,
        "type": "text"
      },
      {
        "name": "patient_id",
        "value": "1234321",
        "type": "text"
      }
    ],
    "optional": false,
    "outputs": [

    ],
    "requests": [
      {
        "id": "baddae85-49d7-490d-b4b3-7b00dfd93d11",
        "direction": "outgoing",
        "index": 279,
        "result_id": "96ff10ed-4fd1-40d8-bb7e-294b866428b3",
        "status": 200,
        "timestamp": "2024-10-08T17:08:18.579-04:00",
        "url": "https://hapi.fhir.org/baseR4/Patient/1234321",
        "verb": "get"
      }
    ],
    "result": "pass",
    "test_id": "dev_validator-patient_group-patient_validate_test",
    "test_run_id": "92302803-1f13-46ef-a66e-793a92ac5fd1",
    "test_session_id": "cG9laeggvmM",
    "updated_at": "2024-10-08T17:08:18.757-04:00"
  },
  {
    "id": "96ff10ed-4fd1-40d8-bb7e-294b866428b3",
    "created_at": "2024-10-08T17:08:18.572-04:00",
    "inputs": [
      {
        "name": "url",
        "value": "https://hapi.fhir.org/baseR4",
        "type": "text"
      },
      {
        "name": "access_token",
        "value": null,
        "type": "text"
      },
      {
        "name": "patient_id",
        "value": "1234321",
        "type": "text"
      }
    ],
    "optional": false,
    "outputs": [

    ],
    "requests": [
      {
        "id": "baddae85-49d7-490d-b4b3-7b00dfd93d11",
        "direction": "outgoing",
        "index": 279,
        "result_id": "96ff10ed-4fd1-40d8-bb7e-294b866428b3",
        "status": 200,
        "timestamp": "2024-10-08T17:08:18.579-04:00",
        "url": "https://hapi.fhir.org/baseR4/Patient/1234321",
        "verb": "get"
      }
    ],
    "result": "pass",
    "test_id": "dev_validator-patient_group-patient_read_test",
    "test_run_id": "92302803-1f13-46ef-a66e-793a92ac5fd1",
    "test_session_id": "cG9laeggvmM",
    "updated_at": "2024-10-08T17:08:18.572-04:00"
  }
]

Testing Guidance

checkout branch
bundle install
bundle exec inferno services start
console outputter w/ spinner:

bundle exec inferno execute -s dev_validator -i "url:https://hapi.fhir.org/baseR4" patient_id:1234321

plain outputter:

bundle exec inferno execute -s dev_validator -o plain -i "url:https://hapi.fhir.org/baseR4" patient_id:1234321

quiet outputter:

bundle exec inferno execute -s dev_validator -o quiet -i "url:https://hapi.fhir.org/baseR4" patient_id:1234321

json outputter:

bundle exec inferno execute -s dev_validator -o json -i "url:https://hapi.fhir.org/baseR4" patient_id:1234321

codecov · 2024-10-08T21:10:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.06%. Comparing base (17fd170) to head (157b3c3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #541   +/-   ##
=======================================
  Coverage   84.06%   84.06%           
=======================================
  Files         262      262           
  Lines       11410    11410           
  Branches     1254     1254           
=======================================
  Hits         9592     9592           
  Misses       1808     1808           
  Partials       10       10

Flag	Coverage Δ
backend	`92.19% <ø> (ø)`
frontend	`79.33% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Jammjammjamm · 2024-10-18T13:40:59Z

Gemfile

+end
+gem "tty-spinner", "~> 0.9.3"


This would have to go in the gemspec.

Jammjammjamm · 2024-10-18T13:43:54Z

lib/inferno/apps/cli/execute.rb

+        inflections.acronym 'JSON'
+      end
+
+      OUTPUTTER_WHITELIST = %w[console plain json quiet].freeze


This is all fine, but a Hash mapping the option to the outputter class would be a lot simpler. I don't think being dynamic buys us much here, since we would need to alter code here, as well as documentation when adding new outputters anyway.

Jammjammjamm · 2024-10-21T13:30:39Z

lib/inferno/apps/cli/execute/console_outputter.rb


 module Inferno
  module CLI
    class Execute
      # @private
-      class ConsoleOutputter
-        COLOR = Pastel.new
+      class ConsoleOutputter < JSONOutputter


Unless I'm missing something, I don't think it makes sense for this to inherit from JSONOutputter.

It inherits serialize

Jammjammjamm · 2024-10-21T13:32:11Z

lib/inferno/apps/cli/execute/plain_outputter.rb

+
+        def print_error(_options, exception)
+          puts "Error: #{exception.full_message(highlight: false)}"
+          puts exception.backtrace&.join('\n')


Why is this different from the console outputter version? Also, doesn't full_message already include the stack trace?

Plain outputter needs highlight: false or it outputs ANSI code \e[1 (to make it bold).

But the backtrace part was redundant so I'm removing that.

Jammjammjamm · 2024-10-21T13:32:48Z

lib/inferno/apps/cli/execute/quiet_outputter.rb

+    class Execute
+      # @private
+      class QuietOutputter
+        # rubocop:disable Lint/UnusedMethodArgument


Don't disable this rule. Prefix the arguments with underscore if they're not used.

…ncestors

Shaumik-Ashraf added 10 commits October 7, 2024 11:51

add quiet outputter

288794a

add plain outputter

09916bf

impl json outputters and outputter option

c6259e1

debug

6e91e59

spec and cop

dc863a5

keep job silencer in execute; add spinner

92c931a

write outputter_spec and json_outputter_spec

47fed6d

spec plain and quiet outputters

49f9587

cop

7576474

add in-code documentation

c3d682f

Shaumik-Ashraf requested a review from Jammjammjamm October 8, 2024 21:09

Shaumik-Ashraf self-assigned this Oct 10, 2024

Shaumik-Ashraf added 4 commits October 10, 2024 16:13

Merge branch 'main' into fi-2962-execute-outputters

ab6723a

Merge branch 'main' into fi-2962-execute-outputters

e07fdd7

Merge branch 'main' into fi-2962-execute-outputters

590be67

Merge branch 'main' into fi-2962-execute-outputters

eef78ab

Jammjammjamm reviewed Oct 21, 2024

View reviewed changes

Shaumik-Ashraf added 8 commits October 30, 2024 15:05

move tty-spinner gem to gemspec

1fb7e4a

replace OUTPUTTERS_WHITELIST with OUTPUTTERS hash

b7aadbd

remove redundant backtrace print

86b000b

fix quiet outputter unused variables

65a177c

cop

fcd2a1c

resolve merge conflict with main

7ae50ec

debug

f7f0d74

fix docs

334867f

Shaumik-Ashraf requested a review from Jammjammjamm October 30, 2024 19:51

Shaumik-Ashraf added 3 commits November 1, 2024 11:33

Merge branch 'main' into fi-2962-execute-outputters

4e1d4ce

Merge branch 'main' into fi-2962-execute-outputters

5770bb8

Merge branch 'main' into fi-2962-execute-outputters

d8b1052

Shaumik-Ashraf added 4 commits November 13, 2024 14:32

remove serialize standard error; use demodulize

5618f4e

factorize serializer and remove JSONOutputter from ConsoleOutputter a…

df5f0b2

…ncestors

create serialize_spec, rspec, and cop

aedfe06

Merge branch 'main' into fi-2962-execute-outputters

3d8ff0f

Shaumik-Ashraf requested review from Jammjammjamm and removed request for Jammjammjamm November 14, 2024 22:34

Shaumik-Ashraf added 3 commits November 15, 2024 11:22

yank spinner

96fa788

rm tty-spinner gem

de121a3

cop

157b3c3

Jammjammjamm approved these changes Nov 15, 2024

View reviewed changes

Shaumik-Ashraf merged commit af1e650 into main Nov 15, 2024
10 checks passed

Shaumik-Ashraf deleted the fi-2962-execute-outputters branch November 15, 2024 17:18

Shaumik-Ashraf mentioned this pull request Nov 25, 2024

Release v0.5.1 #566

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fi 2962 execute outputters #541

Fi 2962 execute outputters #541

Shaumik-Ashraf commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading

Jammjammjamm Oct 18, 2024

Jammjammjamm Oct 18, 2024

Jammjammjamm Oct 21, 2024

Shaumik-Ashraf Oct 24, 2024

Jammjammjamm Oct 21, 2024

Shaumik-Ashraf Oct 30, 2024

Jammjammjamm Oct 21, 2024

Fi 2962 execute outputters #541

Fi 2962 execute outputters #541

Conversation

Shaumik-Ashraf commented Oct 8, 2024 • edited Loading

Summary

JSON Output format (for dev_validator suite):

Testing Guidance

codecov bot commented Oct 8, 2024 • edited Loading

Codecov Report

Jammjammjamm Oct 18, 2024

Choose a reason for hiding this comment

Jammjammjamm Oct 18, 2024

Choose a reason for hiding this comment

Jammjammjamm Oct 21, 2024

Choose a reason for hiding this comment

Shaumik-Ashraf Oct 24, 2024

Choose a reason for hiding this comment

Jammjammjamm Oct 21, 2024

Choose a reason for hiding this comment

Shaumik-Ashraf Oct 30, 2024

Choose a reason for hiding this comment

Jammjammjamm Oct 21, 2024

Choose a reason for hiding this comment

Shaumik-Ashraf commented Oct 8, 2024 •

edited

Loading

codecov bot commented Oct 8, 2024 •

edited

Loading