propel_api 0.1.1

data/lib/generators/propel_api/templates/tests/integration_test_template.rb.tt

@@ -0,0 +1,487 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class <%= class_name %>ApiTest < ActionDispatch::IntegrationTest
+  
+  def setup
+    @organization = organizations(:one)
+    @user = users(:one)
+    @<%= singular_table_name %> = <%= table_name %>(:one)
+    @token = @user.generate_jwt_token
+    @auth_headers = { 'Authorization' => "Bearer #{@token}" }
+    
+    # Ensure test <%= singular_table_name %> belongs to test user's organization
+    @<%= singular_table_name %>.update!(organization: @organization)
+  end
+
+  # === FULL CRUD WORKFLOW TESTS ===
+  
+  test "complete <%= singular_table_name %> lifecycle workflow" do
+    # Step 1: List empty resources
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    initial_response = JSON.parse(response.body)
+    initial_count = initial_response['data'].size
+    
+    # Step 2: Create new <%= singular_table_name %>
+    new_<%= singular_table_name %>_params = {
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.type == :references -%>
+      <%= attribute.name %>_id: @<%= attribute.name %>.id<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+      <%= attribute.name %>: "Workflow Test <%= attribute.name.humanize %>"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+      <%= attribute.name %>: "Workflow test <%= attribute.name.humanize %> content"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+      <%= attribute.name %>: 100<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+      <%= attribute.name %>: true<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+      <%= attribute.name %>: 100.50<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+      <%= attribute.name %>: "workflow_test"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+    }
+    
+    post <%= api_route_helper %>_url,
+         params: { data: new_<%= singular_table_name %>_params },
+         headers: @auth_headers
+    
+    assert_response :created
+    create_response = JSON.parse(response.body)
+    created_<%= singular_table_name %> = create_response['data']
+    created_id = created_<%= singular_table_name %>['id']
+    
+    # Verify created <%= singular_table_name %> data
+    assert_equal @organization.id, created_<%= singular_table_name %>['organization']['id']
+    assert_equal @user.id, created_<%= singular_table_name %>['user']['id']
+<% attributes.each do |attribute| -%>
+<% unless attribute.type == :references -%>
+<% if attribute.type == :string -%>
+    assert_equal "Workflow Test <%= attribute.name.humanize %>", created_<%= singular_table_name %>['<%= attribute.name %>']
+<% elsif attribute.type == :text -%>
+    assert_equal "Workflow test <%= attribute.name.humanize %> content", created_<%= singular_table_name %>['<%= attribute.name %>']
+<% elsif attribute.type == :integer -%>
+    assert_equal 100, created_<%= singular_table_name %>['<%= attribute.name %>']
+<% elsif attribute.type == :boolean -%>
+    assert_equal true, created_<%= singular_table_name %>['<%= attribute.name %>']
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+    assert_equal 100.5, created_<%= singular_table_name %>['<%= attribute.name %>']
+<% else -%>
+    assert_equal "workflow_test", created_<%= singular_table_name %>['<%= attribute.name %>']
+<% end -%>
+<% end -%>
+<% end -%>
+    
+    # Step 3: Verify list now includes new <%= singular_table_name %>
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    list_response = JSON.parse(response.body)
+    assert_equal initial_count + 1, list_response['data'].size
+    
+    <%= table_name %>_ids = list_response['data'].map { |item| item['id'] }
+    assert_includes <%= table_name %>_ids, created_id
+    
+    # Step 4: Retrieve specific <%= singular_table_name %>
+    get <%= api_route_helper %>_url(created_id), headers: @auth_headers
+    assert_response :success
+    
+    show_response = JSON.parse(response.body)
+    show_<%= singular_table_name %> = show_response['data']
+    assert_equal created_id, show_<%= singular_table_name %>['id']
+    
+    # Step 5: Update the <%= singular_table_name %>
+<% if attributes.any? { |attr| attr.type == :string && attr.name != "organization" && attr.name != "user" } -%>
+<% string_attr = attributes.find { |attr| attr.type == :string && attr.name != "organization" && attr.name != "user" } -%>
+    update_params = { <%= string_attr.name %>: "Updated Workflow <%= string_attr.name.humanize %>" }
+    
+    patch <%= api_route_helper %>_url(created_id),
+          params: { data: update_params },
+          headers: @auth_headers
+    
+    assert_response :success
+    
+    update_response = JSON.parse(response.body)
+    updated_<%= singular_table_name %> = update_response['data']
+    assert_equal "Updated Workflow <%= string_attr.name.humanize %>", updated_<%= singular_table_name %>['<%= string_attr.name %>']
+<% else -%>
+    # Update test - customize based on your model's attributes
+    patch <%= api_route_helper %>_url(created_id),
+          params: { data: new_<%= singular_table_name %>_params },
+          headers: @auth_headers
+    
+    assert_response :success
+<% end -%>
+    
+    # Step 6: Delete the <%= singular_table_name %>
+    delete <%= api_route_helper %>_url(created_id), headers: @auth_headers
+    assert_response :no_content
+    
+    # Step 7: Verify <%= singular_table_name %> is gone
+    get <%= api_route_helper %>_url(created_id), headers: @auth_headers
+    assert_response :not_found
+    
+    # Step 8: Verify list count is back to original
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    final_response = JSON.parse(response.body)
+    assert_equal initial_count, final_response['data'].size
+  end
+
+  # === PAGINATION WORKFLOW TESTS ===
+  
+  test "pagination workflow with multiple <%= table_name %>" do
+    # Create multiple <%= table_name %> for pagination testing
+    <%= table_name %> = []
+    10.times do |i|
+      <%= singular_table_name %> = <%= class_name %>.create!(
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.type == :references -%>
+        <%= attribute.name %>: @<%= attribute.name %><%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+        <%= attribute.name %>: "Pagination Test <%= attribute.name.humanize %> #{i}"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+        <%= attribute.name %>: "Pagination test <%= attribute.name.humanize %> content #{i}"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+        <%= attribute.name %>: i<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+        <%= attribute.name %>: i.even?<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+        <%= attribute.name %>: i * 10.5<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+        <%= attribute.name %>: "test_#{i}"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+      )
+      <%= table_name %> << <%= singular_table_name %>
+    end
+    
+    # Test first page
+    get <%= api_route_helper %>_url, params: { page: 1, limit: 5 }, headers: @auth_headers
+    assert_response :success
+    
+    page1_response = JSON.parse(response.body)
+    assert_equal 5, page1_response['data'].size
+    
+    pagination = page1_response['pagination']
+    assert_equal 1, pagination['page']
+    assert_equal 5, pagination['items']
+    assert pagination['count'] >= 10
+    assert pagination['pages'] >= 2
+    assert_equal false, pagination['first']
+    assert_equal false, pagination['last']
+    
+    # Test second page
+    get <%= api_route_helper %>_url, params: { page: 2, limit: 5 }, headers: @auth_headers
+    assert_response :success
+    
+    page2_response = JSON.parse(response.body)
+    assert_equal 5, page2_response['data'].size
+    
+    pagination2 = page2_response['pagination']
+    assert_equal 2, pagination2['page']
+    assert_equal 5, pagination2['items']
+    
+    # Verify different records on different pages
+    page1_ids = page1_response['data'].map { |item| item['id'] }
+    page2_ids = page2_response['data'].map { |item| item['id'] }
+    assert_empty (page1_ids & page2_ids), "Pages should contain different records"
+  end
+
+  # === ERROR HANDLING WORKFLOW TESTS ===
+  
+  test "error handling workflow" do
+    # Test 1: Invalid authentication
+    get <%= api_route_helper %>_url, headers: { 'Authorization' => 'Bearer invalid_token' }
+    assert_response :unauthorized
+    
+    error_response = JSON.parse(response.body)
+    assert_equal "Invalid token", error_response['error']
+    
+    # Test 2: Missing authentication
+    get <%= api_route_helper %>_url
+    assert_response :unauthorized
+    
+    error_response = JSON.parse(response.body)
+    assert_equal "No token provided", error_response['error']
+    
+    # Test 3: Invalid resource ID
+    get <%= api_route_helper %>_url(99999), headers: @auth_headers
+    assert_response :not_found
+    
+    # Test 4: Invalid create params
+    post <%= api_route_helper %>_url,
+         params: { data: { invalid_field: "invalid_value" } },
+         headers: @auth_headers
+    
+    assert_response :unprocessable_entity
+    
+    error_response = JSON.parse(response.body)
+    assert_includes error_response.keys, 'errors'
+    
+    # Test 5: Malformed JSON
+    post <%= api_route_helper %>_url,
+         params: "invalid json",
+         headers: @auth_headers.merge('Content-Type' => 'application/json')
+    
+    assert_response :bad_request
+  end
+
+  # === MULTI-TENANCY WORKFLOW TESTS ===
+  
+  test "multi-tenancy isolation workflow" do
+    # Create another organization and user
+    other_organization = Organization.create!(name: "Other Organization")
+    other_user = User.create!(
+      email_address: "other@example.com",
+      username: "otheruser",
+      first_name: "Other",
+      last_name: "User",
+      password: "password123",
+      organization: other_organization
+    )
+    other_token = other_user.generate_jwt_token
+    other_headers = { 'Authorization' => "Bearer #{other_token}" }
+    
+    # Create <%= singular_table_name %> in each organization
+    org1_<%= singular_table_name %> = <%= class_name %>.create!(
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.name == "organization" && attribute.type == :references -%>
+      <%= attribute.name %>: @organization<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.name == "user" && attribute.type == :references -%>
+      <%= attribute.name %>: @user<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :references -%>
+      <%= attribute.name %>: @<%= attribute.name %><%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+      <%= attribute.name %>: "Org 1 <%= attribute.name.humanize %>"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+      <%= attribute.name %>: "Org 1 <%= attribute.name.humanize %> content"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+      <%= attribute.name %>: 1<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+      <%= attribute.name %>: true<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+      <%= attribute.name %>: 11.1<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+      <%= attribute.name %>: "org1_value"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+    )
+    
+    org2_<%= singular_table_name %> = <%= class_name %>.create!(
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.name == "organization" && attribute.type == :references -%>
+      <%= attribute.name %>: other_organization<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.name == "user" && attribute.type == :references -%>
+      <%= attribute.name %>: other_user<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :references -%>
+      <%= attribute.name %>: @<%= attribute.name %><%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+      <%= attribute.name %>: "Org 2 <%= attribute.name.humanize %>"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+      <%= attribute.name %>: "Org 2 <%= attribute.name.humanize %> content"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+      <%= attribute.name %>: 2<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+      <%= attribute.name %>: false<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+      <%= attribute.name %>: 22.2<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+      <%= attribute.name %>: "org2_value"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+    )
+    
+    # Org 1 user should only see Org 1 <%= table_name %>
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    org1_response = JSON.parse(response.body)
+    org1_ids = org1_response['data'].map { |item| item['id'] }
+    
+    assert_includes org1_ids, org1_<%= singular_table_name %>.id
+    assert_not_includes org1_ids, org2_<%= singular_table_name %>.id
+    
+    # Org 2 user should only see Org 2 <%= table_name %>
+    get <%= api_route_helper %>_url, headers: other_headers
+    assert_response :success
+    
+    org2_response = JSON.parse(response.body)
+    org2_ids = org2_response['data'].map { |item| item['id'] }
+    
+    assert_includes org2_ids, org2_<%= singular_table_name %>.id
+    assert_not_includes org2_ids, org1_<%= singular_table_name %>.id
+    
+    # Cross-organization access should be denied
+    get <%= api_route_helper %>_url(org2_<%= singular_table_name %>.id), headers: @auth_headers
+    assert_response :not_found
+    
+    get <%= api_route_helper %>_url(org1_<%= singular_table_name %>.id), headers: other_headers
+    assert_response :not_found
+  end
+
+  # === FACET RESPONSE WORKFLOW TESTS ===
+  
+  test "facet response format workflow" do
+    # Test index response (short facet)
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    index_response = JSON.parse(response.body)
+    
+    # Verify pagination structure
+    assert_includes index_response.keys, 'data'
+    assert_includes index_response.keys, 'pagination'
+    assert_kind_of Array, index_response['data']
+    assert_kind_of Hash, index_response['pagination']
+    
+    # Verify pagination metadata
+    pagination = index_response['pagination']
+    %w[page items count pages first last next prev].each do |key|
+      assert_includes pagination.keys, key, "Pagination should include #{key}"
+    end
+    
+    # Test show response (details facet)
+    get <%= api_route_helper %>_url(@<%= singular_table_name %>.id), headers: @auth_headers
+    assert_response :success
+    
+    show_response = JSON.parse(response.body)
+    
+    # Verify response structure
+    assert_includes show_response.keys, 'data'
+    assert_kind_of Hash, show_response['data']
+    
+    <%= singular_table_name %>_data = show_response['data']
+    
+    # Verify core fields are present
+    assert_includes <%= singular_table_name %>_data.keys, 'id'
+    assert_includes <%= singular_table_name %>_data.keys, 'organization'
+    assert_includes <%= singular_table_name %>_data.keys, 'user'
+    
+    # Verify associations are properly included
+    assert_kind_of Hash, <%= singular_table_name %>_data['organization']
+    assert_kind_of Hash, <%= singular_table_name %>_data['user']
+    assert_equal @organization.id, <%= singular_table_name %>_data['organization']['id']
+    assert_equal @user.id, <%= singular_table_name %>_data['user']['id']
+  end
+
+  # === CONCURRENT ACCESS WORKFLOW TESTS ===
+  
+  test "concurrent modifications workflow" do
+    # Create a <%= singular_table_name %> to modify
+    test_<%= singular_table_name %> = <%= class_name %>.create!(
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.type == :references -%>
+      <%= attribute.name %>: @<%= attribute.name %><%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+      <%= attribute.name %>: "Concurrent Test <%= attribute.name.humanize %>"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+      <%= attribute.name %>: "Concurrent test <%= attribute.name.humanize %> content"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+      <%= attribute.name %>: 50<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+      <%= attribute.name %>: true<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+      <%= attribute.name %>: 50.5<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+      <%= attribute.name %>: "concurrent_test"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+    )
+    
+    # Simulate concurrent read
+    get <%= api_route_helper %>_url(test_<%= singular_table_name %>.id), headers: @auth_headers
+    assert_response :success
+    
+    # Simulate concurrent update
+<% if attributes.any? { |attr| attr.type == :string && attr.name != "organization" && attr.name != "user" } -%>
+<% string_attr = attributes.find { |attr| attr.type == :string && attr.name != "organization" && attr.name != "user" } -%>
+    patch <%= api_route_helper %>_url(test_<%= singular_table_name %>.id),
+          params: { data: { <%= string_attr.name %>: "Updated Concurrent <%= string_attr.name.humanize %>" } },
+          headers: @auth_headers
+    
+    assert_response :success
+    
+    # Verify update was successful
+    get <%= api_route_helper %>_url(test_<%= singular_table_name %>.id), headers: @auth_headers
+    assert_response :success
+    
+    updated_response = JSON.parse(response.body)
+    assert_equal "Updated Concurrent <%= string_attr.name.humanize %>", updated_response['data']['<%= string_attr.name %>']
+<% else -%>
+    # Concurrent update test - customize based on your model's attributes
+    patch <%= api_route_helper %>_url(test_<%= singular_table_name %>.id),
+          params: { data: { organization_id: @organization.id } },
+          headers: @auth_headers
+    
+    assert_response :success
+<% end -%>
+  end
+
+  # === BULK OPERATIONS WORKFLOW TESTS ===
+  
+  test "bulk operations workflow" do
+    # Create multiple <%= table_name %> for bulk testing
+    bulk_<%= table_name %> = []
+    5.times do |i|
+      <%= singular_table_name %> = <%= class_name %>.create!(
+<% attributes.each_with_index do |attribute, index| -%>
+<% if attribute.type == :references -%>
+        <%= attribute.name %>: @<%= attribute.name %><%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :string -%>
+        <%= attribute.name %>: "Bulk Test <%= attribute.name.humanize %> #{i}"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :text -%>
+        <%= attribute.name %>: "Bulk test <%= attribute.name.humanize %> content #{i}"<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :integer -%>
+        <%= attribute.name %>: i * 10<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :boolean -%>
+        <%= attribute.name %>: i.even?<%= ',' if index < attributes.length - 1 %>
+<% elsif attribute.type == :decimal || attribute.type == :float -%>
+        <%= attribute.name %>: i * 10.5<%= ',' if index < attributes.length - 1 %>
+<% else -%>
+        <%= attribute.name %>: "bulk_#{i}"<%= ',' if index < attributes.length - 1 %>
+<% end -%>
+<% end -%>
+      )
+      bulk_<%= table_name %> << <%= singular_table_name %>
+    end
+    
+    # Test bulk retrieval
+    get <%= api_route_helper %>_url, headers: @auth_headers
+    assert_response :success
+    
+    bulk_response = JSON.parse(response.body)
+    retrieved_ids = bulk_response['data'].map { |item| item['id'] }
+    
+    # Verify all bulk <%= table_name %> are included
+    bulk_<%= table_name %>.each do |<%= singular_table_name %>|
+      assert_includes retrieved_ids, <%= singular_table_name %>.id, "Bulk <%= singular_table_name %> should be in results"
+    end
+    
+    # Test individual retrieval of bulk items
+    bulk_<%= table_name %>.each do |<%= singular_table_name %>|
+      get <%= api_route_helper %>_url(<%= singular_table_name %>.id), headers: @auth_headers
+      assert_response :success
+      
+      item_response = JSON.parse(response.body)
+      assert_equal <%= singular_table_name %>.id, item_response['data']['id']
+    end
+    
+    # Test bulk deletion
+    bulk_<%= table_name %>.each do |<%= singular_table_name %>|
+      delete <%= api_route_helper %>_url(<%= singular_table_name %>.id), headers: @auth_headers
+      assert_response :no_content
+    end
+    
+    # Verify all items are deleted
+    bulk_<%= table_name %>.each do |<%= singular_table_name %>|
+      get <%= api_route_helper %>_url(<%= singular_table_name %>.id), headers: @auth_headers
+      assert_response :not_found
+    end
+  end
+end