Skip to content

Commit

Permalink
Merge pull request #275 from Akashsah2003/chore/report/week_6-12
Browse files Browse the repository at this point in the history
chore(report): SPDX Expression week 6-12
  • Loading branch information
GMishx committed Sep 2, 2024
2 parents cc73f06 + 9fe910d commit 9608e5f
Show file tree
Hide file tree
Showing 12 changed files with 502 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/2024/spdx-expression/updates/2024-07-02.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Week 6
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 6 Meeting and Activities

_(July 2, 2024)_

## Attendees:

- [Akash Sah](https://github.com/Akashsah2003)
- [Gaurav Mishra](https://github.com/GMishx)
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
- [Dearsh Oberoi](https://github.com/deo002)
- [Abhishek Kumar](https://github.com/abhi-kumar17871)

## Discussions

### RDF and Tag Value Reports

- Presented my work on RDF and tag value reports.
- Discussed how to concatenate two license expressions that are main licenses.
- There should be no duplicate license expressions in the `license_expression` table.
- For user decisions, license expressions should be stored in the `clearing_event` table.
- Validation of license expressions will be completed later when everything is finalized.

## Activities

- Worked on CycloneDX and DEP5 reports.

## Sample Reports

- [CycloneDX report Sample](/reports/CYCLONEDX_JSON_Test19.zip_2024-08-18_11_47_57.json)
- [DEP5 report Sample](/reports/DEP5_Test19.zip_1723962090.txt)
36 changes: 36 additions & 0 deletions docs/2024/spdx-expression/updates/2024-07-09.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Week 7
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 7 Meeting and Activities

_(July 9, 2024)_

## Attendees:

- [Akash Sah](https://github.com/Akashsah2003)
- [Gaurav Mishra](https://github.com/GMishx)
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
- [Dearsh Oberoi](https://github.com/deo002)
- [Abhishek Kumar](https://github.com/abhi-kumar17871)

## Discussions

### CycloneDX and DEP5 Reports

- Presented my work on CycloneDX and DEP5 reports.
- Identified other report formats that need changes: Unified Report, CLI XML.
- Next steps include working on removing duplicate expressions and clearing part of expressions.

## Activities

- Modified OJO to prevent storing duplicate license expressions.
- Began working on the clearing part of expressions.
38 changes: 38 additions & 0 deletions docs/2024/spdx-expression/updates/2024-07-16.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Week 8
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 8 Meeting and Activities

_(July 16, 2024)_

## Attendees:

- [Akash Sah](https://github.com/Akashsah2003)
- [Gaurav Mishra](https://github.com/GMishx)
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
- [Dearsh Oberoi](https://github.com/deo002)
- [Abhishek Kumar](https://github.com/abhi-kumar17871)

## Discussions

### Clearing Part of License Expression

- Presented my work on the clearing part of the license expression.
- License expressions can now be cleared, and the cleared expressions are used for generating reports.
- Edited license expressions appear in Clearing History as added and removed expressions.
#### Clearing History
![Clearing History](/img/spdx-expression/clearingHistory.png)
- Will need to update the APIs related to licenses and clearing history in the future.

## Activities

- Developed a functionality where users can add license expressions for items that previously had no license expressions (User Decision License Expressions).
37 changes: 37 additions & 0 deletions docs/2024/spdx-expression/updates/2024-07-23.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Week 9
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 9 Meeting and Activities

_(July 23, 2024)_

## Attendees:

- [Akash Sah](https://github.com/Akashsah2003)
- [Gaurav Mishra](https://github.com/GMishx)
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
- [Dearsh Oberoi](https://github.com/deo002)
- [Abhishek Kumar](https://github.com/abhi-kumar17871)

## Discussions

### User Decision License Expressions

- Presented my work on User Decision License Expressions.
- Acknowledgement should be added to license expressions.
- Users should be able to add license expressions and main licenses, and multiple license expressions should be concatenated with the `AND` operator when generating the reports.
- Remove dual license results from `nomo` and `ojo`.
- Decision exporter and importer should be modified to include license expression results.

## Activities

- Corrected failing unit tests for PR #2771.
31 changes: 31 additions & 0 deletions docs/2024/spdx-expression/updates/2024-07-30.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Week 10
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 10 Meeting and Activities

_(July 30, 2024)_

## Meeting

- I was unable to attend the meeting this week because I was traveling.

## Activities

- Added acknowledgments to license expressions.
#### Acknowledgement for license expression
![Acknowledgement for expression](/img/spdx-expression/acknowledgementExpression.png)
- Removed dual license results from `nomo` and `ojo`.
- Modified all the reports to inctegrate license expression as main licenses.

## Next Steps

- I will be working on correcting the Decision exporter and importer.
32 changes: 32 additions & 0 deletions docs/2024/spdx-expression/updates/2024-08-06.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Week 11
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 11 Meeting and Activities

_(August 6, 2024)_

## Meeting

- The meeting was rescheduled as some members of the REST team and the SPDX team were unavailable.
- The new meeting time has been set for every Friday from 11:00 to 11:30 UTC.

## Activities

- Worked on exporting and importing license decisions.

## Sample Reports

- [Decision Exporter](/reports/FOSSology_Decisions_Test19.zip_18_08_2024_12_58_22.json)

## Next Steps

- Will focus on developing APIs related to license expressions and clearing history.
41 changes: 41 additions & 0 deletions docs/2024/spdx-expression/updates/2024-08-16.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Week 12
author: Akash Sah
tags: [gsoc24, spdx-expression]
---

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2024 Akash Sah <[email protected]>
-->

# Week 12 Meeting and Activities

_(August 16, 2024)_

## Attendees:

- [Akash Sah](https://github.com/Akashsah2003)
- [Gaurav Mishra](https://github.com/GMishx)
- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
- [Dearsh Oberoi](https://github.com/deo002)
- [Abhishek Kumar](https://github.com/abhi-kumar17871)

## Discussions

### API Work and Report Formats

- Presented my work on 6 APIs.
- Discussed the need to modify the `POST` endpoint at `/uploads/{uploadId}/expression/main` to ensure only cleared license expressions for any item in an upload can be added as the main expression.
- Received formats for CLI XML and unified reports, which will be updated accordingly.

## Activities

- Modified `Ojo` to prevent creating License Expressions for items with a single license.
- Modified `GET /uploads/{uploadId}/licenses/main` to include an optional boolean query parameter `includeExpressions` for retrieving main licenses including expressions.
- Modified `GET /uploads/{uploadId}/item/{itemId}/licenses` to include an optional boolean query parameter `includeExpressions` for retrieving license decisions including expressions for an item.
- Modified `GET /uploads/{uploadId}/item/{itemId}/clearing-history` to include an optional boolean query parameter `includeExpressions` for retrieving the clearing history including expressions for an item.
- Created `POST /uploads/{uploadId}/expression/main` to add license expressions as the main license for an upload.
- Created `DELETE /uploads/{uploadId}/expression/main` to remove license expressions as the main license for an upload.
- Created `PUT /uploads/{uploadId}/item/{itemId}/expression` to set license expression decisions for an item.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/spdx-expression/clearingHistory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 9608e5f

Please sign in to comment.