Merge pull request #4671 from pangaeatech/pangaeatech/nuget-devSupport

Adding "devDependencies" support for nuget projects.
dependabot · Jan 27, 2022 · 5a421b1 · 5a421b1
2 parents 573b6bf + b54332d
commit 5a421b1
Show file tree

Hide file tree

Showing 15 changed files with 175 additions and 74 deletions.
diff --git a/nuget/lib/dependabot/nuget/file_parser/packages_config_parser.rb b/nuget/lib/dependabot/nuget/file_parser/packages_config_parser.rb
@@ -33,7 +33,7 @@ def dependency_set
                 requirements: [{
                   requirement: dependency_version(dependency_node),
                   file: packages_config.name,
-                  groups: [],
+                  groups: [dependency_type(dependency_node)],
                   source: nil
                 }]
               )
@@ -57,6 +57,12 @@ def dependency_version(dependency_node)
           dependency_node.attribute("version")&.value&.strip ||
             dependency_node.at_xpath("./version")&.content&.strip
         end
+
+        def dependency_type(dependency_node)
+          val = dependency_node.attribute("developmentDependency")&.value&.strip ||
+                dependency_node.at_xpath("./developmentDependency")&.content&.strip
+          val.to_s.downcase == "true" ? "devDependencies" : "dependencies"
+        end
       end
     end
   end

diff --git a/nuget/lib/dependabot/nuget/file_parser/project_file_parser.rb b/nuget/lib/dependabot/nuget/file_parser/project_file_parser.rb
@@ -39,10 +39,12 @@ def dependency_set(project_file:)
             req = dependency_requirement(dependency_node, project_file)
             version = dependency_version(dependency_node, project_file)
             prop_name = req_property_name(dependency_node)
+            is_dev = dependency_node.name == "DevelopmentDependency"
 
-            dependency = build_dependency(name, req, version, prop_name, project_file)
+            dependency = build_dependency(name, req, version, prop_name, project_file, dev: is_dev)
             dependency_set << dependency if dependency
           end
+
           # Look for SDK references; see:
           # https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk
           add_sdk_references(doc, dependency_set, project_file)
@@ -109,7 +111,7 @@ def add_sdk_refs_from_sdk_tags(doc, dependency_set, project_file)
           end
         end
 
-        def build_dependency(name, req, version, prop_name, project_file)
+        def build_dependency(name, req, version, prop_name, project_file, dev: false)
           return unless name
 
           # Exclude any dependencies specified using interpolation
@@ -118,7 +120,7 @@ def build_dependency(name, req, version, prop_name, project_file)
           requirement = {
             requirement: req,
             file: project_file.name,
-            groups: [],
+            groups: [dev ? "devDependencies" : "dependencies"],
             source: nil
           }
 

diff --git a/nuget/spec/dependabot/nuget/file_parser/packages_config_parser_spec.rb b/nuget/spec/dependabot/nuget/file_parser/packages_config_parser_spec.rb
@@ -34,7 +34,26 @@
             [{
               requirement: "1.0.0",
               file: "packages.config",
-              groups: [],
+              groups: ["dependencies"],
+              source: nil
+            }]
+          )
+        end
+      end
+
+      describe "the second dependency" do
+        subject(:dependency) { dependencies.at(1) }
+
+        it "has the right details" do
+          expect(dependency).to be_a(Dependabot::Dependency)
+          expect(dependency.name).
+            to eq("Microsoft.Net.Compilers")
+          expect(dependency.version).to eq("1.0.1")
+          expect(dependency.requirements).to eq(
+            [{
+              requirement: "1.0.1",
+              file: "packages.config",
+              groups: ["devDependencies"],
               source: nil
             }]
           )

diff --git a/nuget/spec/dependabot/nuget/file_parser/project_file_parser_spec.rb b/nuget/spec/dependabot/nuget/file_parser/project_file_parser_spec.rb
@@ -33,7 +33,7 @@
             [{
               requirement: "1.1.1",
               file: "my.csproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -51,7 +51,7 @@
             [{
               requirement: nil,
               file: "my.csproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -69,7 +69,7 @@
             [{
               requirement: "4.3.0",
               file: "my.csproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -167,7 +167,7 @@
               [{
                 requirement: "0.1.434",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil,
                 metadata: { property_name: "NukeVersion" }
               }]
@@ -192,7 +192,7 @@
               [{
                 requirement: "0.1.434",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil,
                 metadata: { property_name: "NukeVersion" }
               }]
@@ -218,7 +218,7 @@
                 [{
                   requirement: "$(UnknownVersion)",
                   file: "my.csproj",
-                  groups: [],
+                  groups: ["dependencies"],
                   source: nil,
                   metadata: { property_name: "UnknownVersion" }
                 }]
@@ -231,9 +231,40 @@
       context "with a nuproj" do
         let(:file_body) { fixture("csproj", "basic.nuproj") }
 
-        it "has the right details" do
-          expect(dependencies.map(&:name)).
-            to match_array(%w(nanoFramework.CoreLibrary))
+        it "gets the right number of dependencies" do
+          expect(dependencies.count).to eq(2)
+        end
+
+        describe "the first dependency" do
+          subject(:dependency) { dependencies.first }
+
+          it "has the right details" do
+            expect(dependency).to be_a(Dependabot::Dependency)
+            expect(dependency.name).to eq("nanoFramework.CoreLibrary")
+            expect(dependency.version).to eq("1.0.0-preview062")
+            expect(dependency.requirements).to eq([{
+              requirement: "[1.0.0-preview062]",
+              file: "my.csproj",
+              groups: ["dependencies"],
+              source: nil
+            }])
+          end
+        end
+
+        describe "the second dependency" do
+          subject(:dependency) { dependencies.at(1) }
+
+          it "has the right details" do
+            expect(dependency).to be_a(Dependabot::Dependency)
+            expect(dependency.name).to eq("nanoFramework.CoreExtra")
+            expect(dependency.version).to eq("1.0.0-preview061")
+            expect(dependency.requirements).to eq([{
+              requirement: "[1.0.0-preview061]",
+              file: "my.csproj",
+              groups: ["devDependencies"],
+              source: nil
+            }])
+          end
         end
       end
 
@@ -261,7 +292,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "1.2.3",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end
@@ -277,7 +308,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "0.1.0-beta",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end
@@ -299,7 +330,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "1.2.3",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end
@@ -315,7 +346,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "0.1.0-beta",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end
@@ -337,7 +368,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "1.2.3",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end
@@ -353,7 +384,7 @@
               expect(dependency.requirements).to eq([{
                 requirement: "0.1.0-beta",
                 file: "my.csproj",
-                groups: [],
+                groups: ["dependencies"],
                 source: nil
               }])
             end

diff --git a/nuget/spec/dependabot/nuget/file_parser_spec.rb b/nuget/spec/dependabot/nuget/file_parser_spec.rb
@@ -38,7 +38,7 @@
           [{
             requirement: "1.1.1",
             file: "my.csproj",
-            groups: [],
+            groups: ["dependencies"],
             source: nil
           }]
         )
@@ -56,7 +56,7 @@
           [{
             requirement: "4.3.0",
             file: "my.csproj",
-            groups: [],
+            groups: ["dependencies"],
             source: nil
           }]
         )
@@ -85,12 +85,12 @@
             [{
               requirement: "1.1.1",
               file: "my.csproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }, {
               requirement: "1.0.1",
               file: "my.vbproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -108,7 +108,7 @@
             [{
               requirement: "2.3.0",
               file: "my.vbproj",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -139,7 +139,26 @@
             [{
               requirement: "1.0.0",
               file: "packages.config",
-              groups: [],
+              groups: ["dependencies"],
+              source: nil
+            }]
+          )
+        end
+      end
+
+      describe "the second dependency" do
+        subject(:dependency) { dependencies.at(1) }
+
+        it "has the right details" do
+          expect(dependency).to be_a(Dependabot::Dependency)
+          expect(dependency.name).
+            to eq("Microsoft.Net.Compilers")
+          expect(dependency.version).to eq("1.0.1")
+          expect(dependency.requirements).to eq(
+            [{
+              requirement: "1.0.1",
+              file: "packages.config",
+              groups: ["devDependencies"],
               source: nil
             }]
           )
@@ -167,7 +186,26 @@
               [{
                 requirement: "1.0.0",
                 file: "dir/packages.config",
-                groups: [],
+                groups: ["dependencies"],
+                source: nil
+              }]
+            )
+          end
+        end
+
+        describe "the second dependency" do
+          subject(:dependency) { dependencies.at(1) }
+
+          it "has the right details" do
+            expect(dependency).to be_a(Dependabot::Dependency)
+            expect(dependency.name).
+              to eq("Microsoft.Net.Compilers")
+            expect(dependency.version).to eq("1.0.1")
+            expect(dependency.requirements).to eq(
+              [{
+                requirement: "1.0.1",
+                file: "dir/packages.config",
+                groups: ["devDependencies"],
                 source: nil
               }]
             )
@@ -234,7 +272,7 @@
             [{
               requirement: "2.3.0",
               file: "commonprops.props",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -264,7 +302,7 @@
             [{
               requirement: "1.1.1",
               file: "packages.props",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )
@@ -294,7 +332,7 @@
             [{
               requirement: "1.1.1",
               file: "directory.packages.props",
-              groups: [],
+              groups: ["dependencies"],
               source: nil
             }]
           )

diff --git a/nuget/spec/dependabot/nuget/file_updater/packages_config_declaration_finder_spec.rb b/nuget/spec/dependabot/nuget/file_updater/packages_config_declaration_finder_spec.rb
@@ -20,7 +20,7 @@
     {
       requirement: declaring_requirement_string,
       file: "packages.config",
-      groups: [],
+      groups: ["dependencies"],
       source: nil
     }
   end

diff --git a/nuget/spec/dependabot/nuget/file_updater/project_file_declaration_finder_spec.rb b/nuget/spec/dependabot/nuget/file_updater/project_file_declaration_finder_spec.rb
@@ -20,7 +20,7 @@
     {
       requirement: declaring_requirement_string,
       file: "my.csproj",
-      groups: [],
+      groups: ["dependencies"],
       source: nil
     }
   end