Class: Makit::DotNet::SolutionClassLib

Inherits:
Object
  • Object
show all
Defined in:
lib/makit/dotnet/solution_classlib.rb

Class Method Summary collapse

Class Method Details

.generate_gitlab_ci(project_name) ⇒ Object 



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/makit/dotnet/solution_classlib.rb', line 98

def self.generate_gitlab_ci(project_name)
  gitlab_ci_content = <<~YAML
    # #{project_name} Class Library Project GitLab CI/CD Pipeline
    # frozen_string_literal: true

    stages:
      - build
      - test
      - pack
      - publish

    variables:
      DOTNET_VERSION: "8.0.x"
      PROJECT_PATH: "source/#{project_name}/#{project_name}.csproj"
      BUILD_CONFIGURATION: "Release"
      TEST_RESULTS_DIR: "test-results"
      COVERAGE_DIR: "coverage"
      PACKAGE_DIR: "artifacts/packages"

    # Cache NuGet packages between jobs
    cache:
      paths:
        - "**/bin/"
        - "**/obj/"
        - "**/packages/"
        - "~/.nuget/packages/"

    # Build job
    build:
      stage: build
      image: mcr.microsoft.com/dotnet/sdk:8.0
      script:
        - echo "Building #{project_name} class library..."
        - dotnet --version
        - dotnet restore $PROJECT_PATH
        - dotnet build $PROJECT_PATH --configuration $BUILD_CONFIGURATION --no-restore
        - echo "Class library build completed successfully!"
      artifacts:
        paths:
          - "**/bin/"
          - "**/obj/"
        expire_in: 1 week
        when: on_success
      rules:
        - if: $CI_PIPELINE_SOURCE == "merge_request_event"
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
        - if: $CI_COMMIT_TAG

    # Test job
    test:
      stage: test
      image: mcr.microsoft.com/dotnet/sdk:8.0
      dependencies:
        - build
      script:
        - echo "Testing #{project_name} class library..."
        - dotnet test $PROJECT_PATH --configuration $BUILD_CONFIGURATION --no-build --verbosity normal
        - echo "Class library tests completed successfully!"
      artifacts:
        paths:
          - $TEST_RESULTS_DIR/
          - $COVERAGE_DIR/
        reports:
          junit: $TEST_RESULTS_DIR/*.xml
        expire_in: 1 week
        when: always
      rules:
        - if: $CI_PIPELINE_SOURCE == "merge_request_event"
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
        - if: $CI_COMMIT_TAG

    # Pack job
    pack:
      stage: pack
      image: mcr.microsoft.com/dotnet/sdk:8.0
      dependencies:
        - test
      script:
        - echo "Packing #{project_name} class library..."
        - mkdir -p $PACKAGE_DIR
        - dotnet pack $PROJECT_PATH --configuration $BUILD_CONFIGURATION --output $PACKAGE_DIR
        - echo "Pack completed successfully!"
      artifacts:
        paths:
          - $PACKAGE_DIR/
        expire_in: 1 month
        when: on_success
      rules:
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
        - if: $CI_COMMIT_TAG

    # Publish job (only on tags)
    publish:
      stage: publish
      image: mcr.microsoft.com/dotnet/sdk:8.0
      dependencies:
        - pack
      script:
        - echo "Publishing #{project_name} class library package..."
        - dotnet nuget push $PACKAGE_DIR/*.nupkg --api-key $NUGET_API_KEY --source $NUGET_SOURCE
        - echo "Publish completed successfully!"
      rules:
        - if: $CI_COMMIT_TAG

    # Code quality job (optional)
    code_quality:
      stage: test
      image: mcr.microsoft.com/dotnet/sdk:8.0
      dependencies:
        - build
      script:
        - echo "Running code quality checks..."
        - dotnet tool install --global dotnet-format
        - dotnet format --verify-no-changes $PROJECT_PATH
        - echo "Code quality checks completed!"
      allow_failure: true
      rules:
        - if: $CI_PIPELINE_SOURCE == "merge_request_event"
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

    # Security scan job (optional)
    security_scan:
      stage: test
      image: mcr.microsoft.com/dotnet/sdk:8.0
      dependencies:
        - build
      script:
        - echo "Running security scan..."
        - dotnet tool install --global dotnet-outdated-tool
        - dotnet outdated $PROJECT_PATH
        - echo "Security scan completed!"
      allow_failure: true
      rules:
        - if: $CI_PIPELINE_SOURCE == "merge_request_event"
        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  YAML

  File.write(".gitlab-ci.yml", gitlab_ci_content)
end

.generate_rakefile(project_name) ⇒ Object 



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
 
# File 'lib/makit/dotnet/solution_classlib.rb', line 16

def self.generate_rakefile(project_name)
  rakefile_content = <<~RUBY
    # frozen_string_literal: true

    require "makit"

    #
    # #{project_name} Class Library Project Rakefile
    #
    desc "default task - builds and tests the class library"
    task :default => [:build, :test]

    desc "build the #{project_name} class library"
    task :build do
      puts "Building #{project_name} class library..."
      project_path = "source/#{project_name}/#{project_name}.csproj"
    #{"  "}
      if File.exist?(project_path)
        sh "dotnet build \#{project_path} --configuration Release"
        puts "Class library build completed successfully!"
      else
        puts "Error: Project file not found at \#{project_path}"
        exit 1
      end
    end

    desc "test the #{project_name} class library"
    task :test do
      puts "Testing #{project_name} class library..."
      project_path = "source/#{project_name}/#{project_name}.csproj"
    #{"  "}
      if File.exist?(project_path)
        sh "dotnet test \#{project_path} --configuration Release --verbosity normal"
        puts "Class library tests completed successfully!"
      else
        puts "Error: Project file not found at \#{project_path}"
        exit 1
      end
    end

    desc "clean build artifacts"
    task :clean do
      puts "Cleaning class library build artifacts..."
      sh "dotnet clean source/#{project_name}/#{project_name}.csproj"
      puts "Clean completed successfully!"
    end

    desc "restore packages"
    task :restore do
      puts "Restoring class library packages..."
      sh "dotnet restore source/#{project_name}/#{project_name}.csproj"
      puts "Restore completed successfully!"
    end

    desc "pack the class library as NuGet package"
    task :pack do
      puts "Packing #{project_name} class library..."
      output_dir = "artifacts/packages"
      FileUtils.mkdir_p(output_dir)
      sh "dotnet pack source/#{project_name}/#{project_name}.csproj --configuration Release --output \#{output_dir}"
      puts "Pack completed successfully! Package: \#{output_dir}/#{project_name}.*.nupkg"
    end

    desc "publish the class library package"
    task :publish => [:pack] do
      puts "Publishing #{project_name} class library package..."
      package_files = Dir.glob("artifacts/packages/#{project_name}.*.nupkg")
      if package_files.any?
        package_files.each do |package|
          sh "dotnet nuget push \#{package} --api-key ${NUGET_API_KEY} --source ${NUGET_SOURCE:-https://api.nuget.org/v3/index.json}"
        end
        puts "Publish completed successfully!"
      else
        puts "Error: No package files found to publish"
        exit 1
      end
    end
  RUBY

  File.write("Rakefile", rakefile_content)
end

.setup(name) ⇒ Object 



6
7
8
9
10
11
12
13
14
 
# File 'lib/makit/dotnet/solution_classlib.rb', line 6

def self.setup(name)
  Makit::DotNet::Project.new_project("razorclasslib", name, "source/#{name}", "--framework net8.0")
  Makit::DotNet::Project.new_project("TUnit", "#{name}.Tests", "tests/#{name}")
  Makit::DotNet::Project.add_reference("tests/#{name}/#{name}.Tests.csproj", "source/#{name}/#{name}.csproj")

  # Generate additional project files
  generate_rakefile(name)
  generate_gitlab_ci(name)
end