File: create_model_service_spec.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (132 lines) | stat: -rw-r--r-- 4,841 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe ::Ml::CreateModelService, feature_category: :mlops do
  let_it_be(:user) { create(:user) }
  let_it_be(:existing_model) { create(:ml_models) }
  let_it_be(:another_project) { create(:project) }
  let_it_be(:description) { 'description' }
  let_it_be(:metadata) { [] }

  let(:audit_event) do
    {
      name: 'ml_model_created',
      author: user,
      scope: project
    }
  end

  before do
    allow(Gitlab::InternalEvents).to receive(:track_event)
    allow(Gitlab::Audit::Auditor).to receive(:audit).and_call_original
  end

  subject(:create_model) { described_class.new(project, name, user, description, metadata).execute }

  describe '#execute', :aggregate_failures do
    subject(:model_payload) { create_model.payload }

    let(:audit_context) do
      audit_event.merge(target: model_payload, message: "MlModel #{name} created")
    end

    context 'when model name is not supplied' do
      let(:name) { nil }
      let(:project) { existing_model.project }

      it 'returns a model with errors' do
        expect { create_model }.not_to change { Ml::Model.count }
        expect(create_model).to be_error
        expect(Gitlab::InternalEvents).not_to have_received(:track_event)
        expect(create_model.message).to include("Name can't be blank")
        expect(Gitlab::Audit::Auditor).not_to have_received(:audit)
      end
    end

    context 'when model name does not exist in the project' do
      let(:name) { 'new_model' }
      let(:project) { existing_model.project }

      it 'creates a model' do
        expect { create_model }.to change { Ml::Model.count }.by(1)
        expect(Gitlab::InternalEvents).to have_received(:track_event).with(
          'model_registry_ml_model_created',
          { project: project, user: user }
        )

        expect(Gitlab::Audit::Auditor).to have_received(:audit).with(audit_context)

        expect(model_payload.name).to eq('new_model')
        expect(model_payload.default_experiment.name).to eq('[model]new_model')
      end
    end

    context 'when model name exists but project is different' do
      let(:name) { existing_model.name }
      let(:project) { another_project }

      it 'creates a model' do
        expect { create_model }.to change { Ml::Model.count }.by(1)
        expect(Gitlab::InternalEvents).to have_received(:track_event).with(
          'model_registry_ml_model_created',
          { project: project, user: user }
        )

        expect(Gitlab::Audit::Auditor).to have_received(:audit).with(audit_context)
        expect(model_payload.name).to eq(name)
      end
    end

    context 'when model with name exists' do
      let(:name) { existing_model.name }
      let(:project) { existing_model.project }

      it 'returns a model with errors' do
        expect { create_model }.not_to change { Ml::Model.count }
        expect(create_model).to be_error
        expect(Gitlab::InternalEvents).not_to have_received(:track_event)
        expect(create_model.message).to eq(["Name should be unique in the project"])
        expect(Gitlab::Audit::Auditor).not_to have_received(:audit)
      end
    end

    context 'when metadata are supplied, add them as metadata' do
      let(:name) { 'new_model' }
      let(:project) { existing_model.project }
      let(:metadata) { [{ key: 'key1', value: 'value1' }, { key: 'key2', value: 'value2' }] }

      it 'creates metadata records' do
        expect { create_model }.to change { Ml::Model.count }.by(1)

        expect(model_payload.name).to eq(name)
        expect(Gitlab::Audit::Auditor).to have_received(:audit).with(audit_context)
        expect(model_payload.metadata.count).to be 2
      end
    end

    # TODO: Ensure consisted error responses https://gitlab.com/gitlab-org/gitlab/-/issues/429731
    context 'for metadata with duplicate keys, it does not create duplicate records' do
      let(:name) { 'new_model' }
      let(:project) { existing_model.project }
      let(:metadata) { [{ key: 'key1', value: 'value1' }, { key: 'key1', value: 'value2' }] }

      it 'raises an error' do
        expect { create_model }.to raise_error(ActiveRecord::RecordInvalid)
        expect(Gitlab::Audit::Auditor).not_to have_received(:audit)
      end
    end

    # TODO: Ensure consisted error responses https://gitlab.com/gitlab-org/gitlab/-/issues/429731
    context 'for metadata with invalid keys, it does not create invalid records' do
      let(:name) { 'new_model' }
      let(:project) { existing_model.project }
      let(:metadata) { [{ key: 'key1', value: 'value1' }, { key: '', value: 'value2' }] }

      it 'raises an error' do
        expect { create_model }.to raise_error(ActiveRecord::RecordInvalid)
        expect(Gitlab::Audit::Auditor).not_to have_received(:audit)
      end
    end
  end
end