Add [gitlablicense] services #8024

sunny0826 · 2022-05-31T04:37:17Z

Overview

This service is for displaying the license of porject in GitLab.

calebcartwright · 2022-05-31T15:02:22Z

Updated title so that service tests will run, and closing/reopening since CI doesn't seem to be executing

shields-ci · 2022-05-31T15:04:38Z

	Messages
📖	✨ Thanks for your contribution to Shields, @sunny0826!

Generated by 🚫 dangerJS against bb0c8a1

calebcartwright

Thank you! Few minor things inline but looking great so far

services/gitlab/gitlab-license.service.js

calebcartwright · 2022-06-03T22:10:23Z

services/gitlab/gitlab-license.service.js

+    if (license) {
+      return renderLicenseBadge({ license })
+    } else {
+      return { message: 'not specified' }
+    }


The renderLicenseBadge helper actually handles cases when there's no license provided:

shields/services/licenses.js

Lines 121 to 123 in fd13db8

if (licenses.length === 0) {

return { message: 'missing', color: 'red' }

}

and the benefit of utilizing that is both simplicity in code and also consistency across our badges.

Did you structure this with different behavior deliberately or was it just simply a case of not knowing the helper handled that, and if it's the former, would you mind explaining your thought process?

I refer to the Github licence for this part.

shields/services/github/github-license.service.js

Lines 29 to 37 in dc06b44

static render({ license }) {

if (license === 'NOASSERTION') {

return { message: 'not identifiable by github' }

} else if (license) {

return renderLicenseBadge({ license })

} else {

return { message: 'not specified' }

}

}

Interesting, thanks for sharing. I'd be curious to know what other maintainers think, if there's more backstory on why GitHub is handled this way. Given the goals of the project I'd be hesitant to introduce this another case of inconsistent behavior in the no license scenario, unless there's good reason

services/gitlab/gitlab-license.service.js

calebcartwright · 2022-06-03T22:16:28Z

services/gitlab/gitlab-license.tester.js

+t.create('Mocking License')
+  .get('/group/project.json')
+  .intercept(nock =>
+    nock('https://gitlab.com')
+      .get('/api/v4/projects/group%2Fproject?license=1')
+      .reply(200, {
+        license: {
+          key: 'apache-2.0',
+          name: 'Apache License 2.0',
+          nickname: '',
+          html_url: 'http://choosealicense.com/licenses/apache-2.0/',
+          source_url: '',
+        },
+      })
+  )
+  .expectBadge({
+    label: 'license',
+    message: 'Apache License 2.0',
+    color: unknownLicenseColor,
+  })


I don't think we necessarily have to remove this test (in part because I realize it bears similarity to the corresponding github tests), but did want to note that it's not necessary for purposes of service/integration tests.

The license renderer is already extensively tested so we're typically content not trying to retest that logic in service tests

Yep, I wrote this test more to show the data structure of licence, so that the developer can understand what fields are in the structure directly through this test case, without having to actually call it.

Understood, and again don't feel like you need to change anything, but my point is that we don't really do that especially not with our service tests. The schema we define in the service class that is used for validating response objects from the upstream APIs is how we typically "document" the structure and relevant fields, along with trying to include links to the upstream documentation.

Compared to other types of tests our service tests are slow and expensive and we typically use them to provide validation against the upstream services we integrate with/to catch when vendors/platforms make breaking changes to their APIs. They can be used to test/do other things, it's just that we typically try to refrain from doing so because of the associated drawbacks.

This is just an fyi/food for thought in case you decide you'd like to work on other badges in the future, GitLab or otherwise

sunny0826 · 2022-06-10T05:09:27Z

@calebcartwright Can this PR be merged, and I hope to contribute a series of badges about GitLab afterwards.

calebcartwright · 2022-06-10T22:28:31Z

@calebcartwright Can this PR be merged, and I hope to contribute a series of badges about GitLab afterwards.

https://github.com/badges/shields/pull/8024/files#r890712363 was still pending in my mind. However, I think my fellow maintainers have been quite busy of late and haven't had much bandwidth for Shields, and I suspect that will continue to be the case for the foreseeable future.

I'll do one more pass and proceed with merging if nothing else jumps out

calebcartwright

Will go ahead and approve but also note a few things that may/will require follow up:

The behavior discussed in Add [gitlablicense] services #8024 (comment) should be revisited, at least to confirm this is desired. I don't have any concerns with proceeding though as we should be able to change this semi-error path later on.
We strive to have our sample parameters used in defaults be valid/usable, so if a user utilizes them to test the badge will work. However, the example listing with the custom server url (https://jihulab.com) ends up being invalid because it is reusing the shared/common props, and there is no gitlab-org/gitlab-foss project on that server. We should update the server url or use explicit project args for the existing server in order for that example to be valid

sunny0826 · 2022-06-12T01:37:35Z

Will go ahead and approve but also note a few things that may/will require follow up:

The behavior discussed in #8024 (comment) should be revisited, at least to confirm this is desired. I don't have any concerns with proceeding though as we should be able to change this semi-error path later on.

We strive to have our sample parameters used in defaults be valid/usable, so if a user utilizes them to test the badge will work. However, the example listing with the custom server url (https://jihulab.com) ends up being invalid because it is reusing the shared/common props, and there is no gitlab-org/gitlab-foss project on that server. We should update the server url or use explicit project args for the existing server in order for that example to be valid

jihulab.com is GitLab's SaaS platform in China, and it is always available. Maybe change the project to gitlab-cn/gitlab, which is public and is used to collaborate with GitLab.com.

calebcartwright · 2022-06-13T00:19:49Z

Maybe change the project to gitlab-cn/gitlab, which is public and is used to collaborate with GitLab.com.

Either way, doesn't really matter. Just want to target a working/valid combination of server url and project reference

sunny0826 added 2 commits May 31, 2022 12:30

feat(gitlab): add gitlab licience services

eed8032

fix

fd13db8

calebcartwright added the service-badge Accepted and actionable changes, features, and bugs label May 31, 2022

calebcartwright changed the title ~~Add gitlab license services~~ Add [gitlablicense] services May 31, 2022

calebcartwright closed this May 31, 2022

calebcartwright reopened this May 31, 2022

calebcartwright reviewed Jun 3, 2022

View reviewed changes

sunny0826 added 3 commits June 6, 2022 08:23

update based on review

4d8c367

Merge branch 'master' into feat/gitlab-license

f31f5cc

rm .tool-verdions file

7cb571e

calebcartwright closed this Jun 7, 2022

calebcartwright reopened this Jun 7, 2022

calebcartwright approved these changes Jun 12, 2022

View reviewed changes

calebcartwright added the squash when passing label Jun 12, 2022

Merge branch 'master' into feat/gitlab-license

bb0c8a1

repo-ranger bot merged commit 781aedc into badges:master Jun 12, 2022

sunny0826 deleted the feat/gitlab-license branch June 12, 2022 01:39

This was referenced Jun 14, 2022

fix: gitlab licence service docs and example #8083

Merged

feat: add [gitlab] contributors service #8084

Merged

chris48s mentioned this pull request Jan 3, 2023

Badge request: GitLab License #7371

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add [gitlablicense] services #8024

Add [gitlablicense] services #8024

sunny0826 commented May 31, 2022

calebcartwright commented May 31, 2022

shields-ci commented May 31, 2022 •

edited

Loading

calebcartwright left a comment

calebcartwright Jun 3, 2022

sunny0826 Jun 6, 2022

calebcartwright Jun 7, 2022

calebcartwright Jun 3, 2022

sunny0826 Jun 6, 2022

calebcartwright Jun 7, 2022

sunny0826 commented Jun 10, 2022

calebcartwright commented Jun 10, 2022

calebcartwright left a comment

sunny0826 commented Jun 12, 2022

calebcartwright commented Jun 13, 2022

	if (licenses.length === 0) {
	return { message: 'missing', color: 'red' }
	}

	static render({ license }) {
	if (license === 'NOASSERTION') {
	return { message: 'not identifiable by github' }
	} else if (license) {
	return renderLicenseBadge({ license })
	} else {
	return { message: 'not specified' }
	}
	}

Add [gitlablicense] services #8024

Add [gitlablicense] services #8024

Conversation

sunny0826 commented May 31, 2022

Overview

calebcartwright commented May 31, 2022

shields-ci commented May 31, 2022 • edited Loading

calebcartwright left a comment

Choose a reason for hiding this comment

calebcartwright Jun 3, 2022

Choose a reason for hiding this comment

sunny0826 Jun 6, 2022

Choose a reason for hiding this comment

calebcartwright Jun 7, 2022

Choose a reason for hiding this comment

calebcartwright Jun 3, 2022

Choose a reason for hiding this comment

sunny0826 Jun 6, 2022

Choose a reason for hiding this comment

calebcartwright Jun 7, 2022

Choose a reason for hiding this comment

sunny0826 commented Jun 10, 2022

calebcartwright commented Jun 10, 2022

calebcartwright left a comment

Choose a reason for hiding this comment

sunny0826 commented Jun 12, 2022

calebcartwright commented Jun 13, 2022

shields-ci commented May 31, 2022 •

edited

Loading