[elixir] Convert proto-based messages to json schema based messages

.github/workflows/test-codegen.yml

@@ -38,6 +38,17 @@ jobs:
       - run: composer install
         working-directory: php
 
+
+      - name: Set up Elixir
+        uses: erlef/setup-beam@v1
+        with:
+          otp-version: '22.2'
+          elixir-version: '1.10.x'
+
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v1
+
+
       - name: generate code for all languages
         run: |
           make clean-all

.github/workflows/test-elixir.yml

@@ -28,9 +28,5 @@ jobs:
           mix deps.get
         working-directory: elixir
 
-      - name: compile messages
-        run: MIX_ENV=prod mix protox.generate --multiple-files --output-path=lib/cucumber_messages/generated messages.proto
-        working-directory: elixir
-
       - run: mix test
         working-directory: elixir

Makefile

@@ -23,7 +23,7 @@ schemas = \
 	./jsonschema/UndefinedParameterType.json \
 	./jsonschema/Envelope.json
 
-languages = go java javascript perl php ruby
+languages = go java javascript perl php ruby elixir
 
 .DEFAULT_GOAL = help
 

elixir/Makefile

@@ -1,25 +1,19 @@
-include default.mk
+schemas = $(shell find ../jsonschema -name "*.json")
 
-clean:
-	rm -rf _build deps .deps .tested
-	rm -rf lib/cucumber_messages/generated/*
+.DEFAULT_GOAL = help
 
-.deps: setup_mix_and_get_dependencies update_proto_file compile_messages revert_proto_file
-	touch .deps
+help: ## Show this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make <target>\n\nWhere <target> is one of:\n"} /^[$$()% a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-setup_mix_and_get_dependencies:
-	mix local.hex --force
-	mix deps.get
-.PHONY: setup_mix_and_get_dependencies
+generate: require .generate-messages ## Generate elixir code based on the schemas found in ../jsonschema and using `mix generate_json_structs` for the generation
 
-update_proto_file: messages.proto
-	mv $< $<.bak
-	cat $<.bak | sed "s/package io.cucumber.messages/package cucumber_messages/" > $<
+require: ## Check requirements for the code generation (elixir/mix is required)
+	@mix --version >/dev/null 2>&1 || (echo "ERROR: elixir/mix is required."; exit 1)
 
-compile_messages:
-	MIX_ENV=prod mix protox.generate --multiple-files --output-path=lib/cucumber_messages/generated messages.proto
-.PHONY: compile_messages
+clean: ## Remove automatically generated files and related artifacts
+	rm -rf lib/cucumber_messages/generated/*
 
-revert_proto_file: messages.proto.bak
-	mv messages.proto.bak messages.proto
-.PHONY: revert_proto_file
+.generate-messages: $(schemas) lib/cucumber_messages/mix/tasks/generate_json_structs.ex
+	mix local.hex --force
+	mix deps.get
+	mix generate_json_structs

elixir/lib/cucumber_message.ex

@@ -10,7 +10,6 @@ defmodule CucumberMessages do
   """
   def convert_envelopes_to(envelopes, :ndjson) do
     Enum.map(envelopes, &CucumberMessages.Writer.envelope_to_ndjson!/1)
-    |> Enum.map(&Jason.encode!(&1))
     |> Enum.join("\n")
     |> case do
       "" -> ""

elixir/lib/cucumber_messages/generated/attachment.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Attachment do
+ defstruct [body: nil, content_encoding: nil, file_name: nil, media_type: nil, source: nil, test_case_started_id: nil, test_step_id: nil, url: nil]
+end

elixir/lib/cucumber_messages/generated/duration.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Duration do
+ defstruct [nanos: nil, seconds: nil]
+end

elixir/lib/cucumber_messages/generated/envelope.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Envelope do
+ defstruct [attachment: nil, gherkin_document: nil, hook: nil, meta: nil, parameter_type: nil, parse_error: nil, pickle: nil, source: nil, step_definition: nil, test_case: nil, test_case_finished: nil, test_case_started: nil, test_run_finished: nil, test_run_started: nil, test_step_finished: nil, test_step_started: nil, undefined_parameter_type: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument do
+ defstruct [comments: [], feature: nil, uri: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_background.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Background do
+ defstruct [description: nil, id: nil, keyword: nil, location: nil, name: nil, steps: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_comment.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Comment do
+ defstruct [location: nil, text: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_data_table.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.DataTable do
+ defstruct [location: nil, rows: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_doc_string.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.DocString do
+ defstruct [content: nil, delimiter: nil, location: nil, media_type: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_examples.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Examples do
+ defstruct [description: nil, id: nil, keyword: nil, location: nil, name: nil, table_body: [], table_header: nil, tags: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_feature.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Feature do
+ defstruct [children: [], description: nil, keyword: nil, language: nil, location: nil, name: nil, tags: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_feature_child.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.FeatureChild do
+ defstruct [background: nil, rule: nil, scenario: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_rule.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Rule do
+ defstruct [children: [], description: nil, id: nil, keyword: nil, location: nil, name: nil, tags: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_rule_child.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.RuleChild do
+ defstruct [background: nil, scenario: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_scenario.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Scenario do
+ defstruct [description: nil, examples: [], id: nil, keyword: nil, location: nil, name: nil, steps: [], tags: []]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_step.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Step do
+ defstruct [data_table: nil, doc_string: nil, id: nil, keyword: nil, keyword_type: nil, location: nil, text: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_table_cell.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.TableCell do
+ defstruct [location: nil, value: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_table_row.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.TableRow do
+ defstruct [cells: [], id: nil, location: nil]
+end

elixir/lib/cucumber_messages/generated/gherkin_document_tag.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.GherkinDocument.Tag do
+ defstruct [id: nil, location: nil, name: nil]
+end

elixir/lib/cucumber_messages/generated/hook.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Hook do
+ defstruct [id: nil, name: nil, source_reference: nil, tag_expression: nil]
+end

elixir/lib/cucumber_messages/generated/location.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Location do
+ defstruct [column: nil, line: nil]
+end

elixir/lib/cucumber_messages/generated/meta.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Meta do
+ defstruct [ci: nil, cpu: nil, implementation: nil, os: nil, protocol_version: nil, runtime: nil]
+end

elixir/lib/cucumber_messages/generated/meta_ci.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Meta.Ci do
+ defstruct [build_number: nil, git: nil, name: nil, url: nil]
+end

elixir/lib/cucumber_messages/generated/meta_git.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Meta.Git do
+ defstruct [branch: nil, remote: nil, revision: nil, tag: nil]
+end

elixir/lib/cucumber_messages/generated/meta_product.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Meta.Product do
+ defstruct [name: nil, version: nil]
+end

elixir/lib/cucumber_messages/generated/parameter_type.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.ParameterType do
+ defstruct [id: nil, name: nil, prefer_for_regular_expression_match: nil, regular_expressions: [], use_for_snippets: nil]
+end

elixir/lib/cucumber_messages/generated/parse_error.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.ParseError do
+ defstruct [message: nil, source: nil]
+end

elixir/lib/cucumber_messages/generated/pickle.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle do
+ defstruct [ast_node_ids: [], id: nil, language: nil, name: nil, steps: [], tags: [], uri: nil]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_doc_string.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleDocString do
+ defstruct [content: nil, media_type: nil]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_step.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleStep do
+ defstruct [argument: nil, ast_node_ids: [], id: nil, text: nil, type: nil]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_step_argument.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleStepArgument do
+ defstruct [data_table: nil, doc_string: nil]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_table.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleTable do
+ defstruct [rows: []]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_table_cell.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleTableCell do
+ defstruct [value: nil]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_table_row.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleTableRow do
+ defstruct [cells: []]
+end

elixir/lib/cucumber_messages/generated/pickle_pickle_tag.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Pickle.PickleTag do
+ defstruct [ast_node_id: nil, name: nil]
+end

elixir/lib/cucumber_messages/generated/source.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Source do
+ defstruct [data: nil, media_type: nil, uri: nil]
+end

elixir/lib/cucumber_messages/generated/source_reference.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.SourceReference do
+ defstruct [java_method: nil, java_stack_trace_element: nil, location: nil, uri: nil]
+end

elixir/lib/cucumber_messages/generated/source_reference_java_method.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.SourceReference.JavaMethod do
+ defstruct [class_name: nil, method_name: nil, method_parameter_types: []]
+end

elixir/lib/cucumber_messages/generated/source_reference_java_stack_trace_element.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.SourceReference.JavaStackTraceElement do
+ defstruct [class_name: nil, file_name: nil, method_name: nil]
+end

elixir/lib/cucumber_messages/generated/step_definition.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.StepDefinition do
+ defstruct [id: nil, pattern: nil, source_reference: nil]
+end

elixir/lib/cucumber_messages/generated/step_definition_step_definition_pattern.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.StepDefinition.StepDefinitionPattern do
+ defstruct [source: nil, type: nil]
+end

elixir/lib/cucumber_messages/generated/test_case.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCase do
+ defstruct [id: nil, pickle_id: nil, test_steps: []]
+end

elixir/lib/cucumber_messages/generated/test_case_finished.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCaseFinished do
+ defstruct [test_case_started_id: nil, timestamp: nil, will_be_retried: nil]
+end

elixir/lib/cucumber_messages/generated/test_case_group.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCase.Group do
+ defstruct [children: [], start: nil, value: nil]
+end

elixir/lib/cucumber_messages/generated/test_case_started.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCaseStarted do
+ defstruct [attempt: nil, id: nil, test_case_id: nil, timestamp: nil]
+end

elixir/lib/cucumber_messages/generated/test_case_step_match_argument.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCase.StepMatchArgument do
+ defstruct [group: nil, parameter_type_name: nil]
+end

elixir/lib/cucumber_messages/generated/test_case_step_match_arguments_list.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCase.StepMatchArgumentsList do
+ defstruct [step_match_arguments: []]
+end

elixir/lib/cucumber_messages/generated/test_case_test_step.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestCase.TestStep do
+ defstruct [hook_id: nil, id: nil, pickle_step_id: nil, step_definition_ids: [], step_match_arguments_lists: []]
+end

elixir/lib/cucumber_messages/generated/test_run_finished.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestRunFinished do
+ defstruct [message: nil, success: nil, timestamp: nil]
+end

elixir/lib/cucumber_messages/generated/test_run_started.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestRunStarted do
+ defstruct [timestamp: nil]
+end

elixir/lib/cucumber_messages/generated/test_step_finished.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestStepFinished do
+ defstruct [test_case_started_id: nil, test_step_id: nil, test_step_result: nil, timestamp: nil]
+end

elixir/lib/cucumber_messages/generated/test_step_finished_test_step_result.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestStepFinished.TestStepResult do
+ defstruct [duration: nil, message: nil, status: nil]
+end

elixir/lib/cucumber_messages/generated/test_step_started.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.TestStepStarted do
+ defstruct [test_case_started_id: nil, test_step_id: nil, timestamp: nil]
+end

elixir/lib/cucumber_messages/generated/timestamp.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.Timestamp do
+ defstruct [nanos: nil, seconds: nil]
+end

elixir/lib/cucumber_messages/generated/undefined_parameter_type.ex

@@ -0,0 +1,3 @@
+defmodule CucumberMessages.UndefinedParameterType do
+ defstruct [expression: nil, name: nil]
+end