Merge pull request #310 from Rakshitha-D/githubWorkflows

#SBCOSS-409: GitHub workflows for code quality check and image publishing

Author: pallakartheekreddy

.github/ghcr-publish.yml

@@ -0,0 +1,44 @@
+name: Build and Publish Docker Image
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get short commit hash
+        id: vars
+        run: echo "commit_hash=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Prepare Docker image name and tag
+        run: |
+          REPO_NAME_LOWERCASE=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
+          TAG_NAME=$(echo "${GITHUB_REF_NAME}" | tr '[:upper:]' '[:lower:]')
+          BUILD_TAG="${TAG_NAME}_${{ steps.vars.outputs.commit_hash }}_${GITHUB_RUN_NUMBER}"
+
+          echo "IMAGE_NAME=ghcr.io/${REPO_NAME_LOWERCASE}" >> $GITHUB_ENV
+          echo "IMAGE_TAG=${BUILD_TAG}" >> $GITHUB_ENV
+
+      - name: Build Docker image
+        run: docker build -t $IMAGE_NAME:$IMAGE_TAG .
+
+      - name: Push Docker image
+        run: docker push $IMAGE_NAME:$IMAGE_TAG

.github/pull_request.yml

@@ -0,0 +1,54 @@
+name: Code Quality Checks
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  code-quality:
+    name: Run Code Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '22.15'
+
+      - name: Restore node_modules cache
+        id: cache
+        uses: actions/cache@v3
+        with:
+          path: src/node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: src
+
+      - name: Save node_modules cache
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: actions/cache@v3
+        with:
+          path: src/node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Run lint
+        run: npm run lint
+        working-directory: src
+
+      - name: Run tests
+        run: npm test
+        working-directory: src
+
+      - name: Run coverage
+        run: npm run coverage
+        working-directory: src

Dockerfile

@@ -1,15 +1,15 @@
 FROM node:22.15-slim
 RUN apt-get update && apt-get install -y git
-COPY .git /opt/content/.git
-COPY src /opt/content/
+COPY . /opt/content/
 WORKDIR /opt/content/
 RUN git config --global --add safe.directory /opt/content
-RUN git submodule update --init --recursive
-RUN npm install --unsafe-perm --production
+RUN git submodule init && \
+    git submodule update
+RUN cd src && npm install --unsafe-perm --production
 
 FROM node:22.15-slim
 
 RUN useradd -m sunbird
 COPY --from=0 --chown=sunbird /opt/content /home/sunbird/mw/content
-WORKDIR /home/sunbird/mw/content/
-CMD ["node", "app.js", "&"]
+WORKDIR /home/sunbird/mw/content/src
+CMD ["node", "app.js", "&"]

README.md

@@ -47,4 +47,50 @@ The code in this repository is licensed under MIT unless otherwise noted. Please
 * Run "npm run test" to run test cases
 * Run "npm run coverage" to run test cases with coverage report
 
+## Code Quality
+
+The project maintains code quality through automated checks that run on every pull request:
+
+1. **Linting**
+   - ESLint for code style and quality
+   - Command: `npm run lint`
+
+2. **Dependencies**
+   - Uses `npm ci` for deterministic installations
+   - GitHub Actions cache for faster builds
+
+3. **Code Formatting**
+   - Ensures consistent code formatting
+   - Can be automatically fixed using `npm run lint:fix`
+
+These checks ensure consistent code style and secure dependency management.
+
+## Container Image Publishing
+
+This repository uses GitHub Actions to automatically build and publish Docker container images to GitHub Container Registry (GHCR) whenever a new tag is pushed to the repository.
+
+### Build and Publish Workflow
+
+The workflow is triggered on:
+- creation of any tag
+
+Key features of the workflow:
+1. Automatically builds Docker images
+2. Tags images with a combination of:
+   - The tag name (lowercased)
+   - Short commit hash
+   - GitHub run number
+3. Publishes images to `ghcr.io` using the repository name
+4. Uses GitHub Actions for secure authentication to GHCR
+
+### Image Naming Convention
+The Docker images follow this naming convention:
+- Repository: `ghcr.io/${OWNER_NAME}/${REPO_NAME_LOWERCASE}`
+- Tag: `${TAG_NAME}_${COMMIT_HASH}_${RUN_NUMBER}`
+
+For example, if you push a tag `v1.0.0` on commit `abc123`, the resulting image would be:
+```
+ghcr.io/sunbird-knowlg/knowledge-mw-service:v1.0.0_abc123_1
+```
+
 

src/helpers/configHelper.js

@@ -11,7 +11,7 @@ var orgDataHelper = require('./orgHelper')
  * data asynchronously and return back a promise
  * @returns promise
  */
-function getAllChannelsFromAPI() {
+function getAllChannelsFromAPI () {
   return new Promise(function (resolve, reject) {
     var limit = 200
     var offset = 0

src/helpers/licenseHelper.js

@@ -19,7 +19,7 @@ function includeLicenseDetails (req, res, cb) {
     let contents = inputContentIsArray ? res.result.content : [res.result.content]
     if (_.size(fieldsToPopulate) && _.size(contents)) {
       populateLicenseDetailsByName(contents, fieldsToPopulate, function
-        (err, contentWithLicenseDetails) {
+      (err, contentWithLicenseDetails) {
         if (!err) {
           res.result.content = inputContentIsArray ? contentWithLicenseDetails : contentWithLicenseDetails[0]
         }

src/helpers/orgHelper.js

@@ -14,7 +14,7 @@ var async = require('async')
  * @param requestObj  js object which contains the search request with filters,offset,limit,query etc
  * @param cb callback after success or error
  */
-function getRootOrgs(requestObj, cb, noExitOnError) {
+function getRootOrgs (requestObj, cb, noExitOnError) {
   logger.debug({ msg: 'getRootOrgs() called', additionalInfo: { requestObj } })
   contentProvider.getAllRootOrgs(requestObj, (err, res) => {
     if (!err) {
@@ -43,7 +43,7 @@ function getRootOrgs(requestObj, cb, noExitOnError) {
    inputdata is array of contents that needs org data
  * @param CBW callback after success or error
  */
-function getRootOrgsFromCache(orgfetchquery, tryfromcache, inputdata, cb) {
+function getRootOrgsFromCache (orgfetchquery, tryfromcache, inputdata, cb) {
   async.waterfall([
     function (CBW) {
       if (tryfromcache) {
@@ -82,7 +82,7 @@ function getRootOrgsFromCache(orgfetchquery, tryfromcache, inputdata, cb) {
   ])
 }
 
-function insertDataToCache(cacheinputdata) {
+function insertDataToCache (cacheinputdata) {
   cacheManager.mset({ data: cacheinputdata, ttl: configData.orgCacheExpiryTime }, function (err, data) {
     if (err) {
       logger.error({ msg: 'Caching allRootOrgs data failed', err, additionalInfo: { data: cacheinputdata } })
@@ -97,7 +97,7 @@ function insertDataToCache(cacheinputdata) {
  * @param inputdata is array of objects, it might be content or course
  * @param cb callback after success or error
  */
-function populateOrgDetailsByHasTag(contents, inputfields, cb) {
+function populateOrgDetailsByHasTag (contents, inputfields, cb) {
   var orgDetails = []
   var orgFetchQuery = {
     'request': {
@@ -168,7 +168,7 @@ function populateOrgDetailsByHasTag(contents, inputfields, cb) {
  * @param inputdata is req object and res object
  * @param cb there will be no error callback , always returns success
  */
-function includeOrgDetails(req, res, cb) {
+function includeOrgDetails (req, res, cb) {
   if (_.get(req, 'query.orgdetails') && _.get(res, 'result.content')) {
     var inputfields = req.query.orgdetails.split(',')
     var fieldsToPopulate = configData.orgfieldsAllowedToSend.filter(eachfield => inputfields.includes(eachfield))
@@ -177,7 +177,7 @@ function includeOrgDetails(req, res, cb) {
     var contents = inputContentIsArray ? res.result.content : [res.result.content]
     if (_.size(fieldsToPopulate) && _.size(contents)) {
       populateOrgDetailsByHasTag(contents, fieldsToPopulate, function
-        (err, contentwithorgdetails) {
+      (err, contentwithorgdetails) {
         if (!err) {
           res.result.content = inputContentIsArray ? contentwithorgdetails : contentwithorgdetails[0]
         }
@@ -192,7 +192,7 @@ function includeOrgDetails(req, res, cb) {
 }
 
 // prepares the set data for inserting in cache
-function prepareCacheDataToInsert(data) {
+function prepareCacheDataToInsert (data) {
   var cacheKeyValuePairs = []
   _.forEach(data, function (eachdata) {
     if (eachdata.hashTagId) {
@@ -205,7 +205,7 @@ function prepareCacheDataToInsert(data) {
 }
 
 // prepares the get data for fetching from cache
-function getKeyNames(data) {
+function getKeyNames (data) {
   var keyNames = []
   _.forEach(data, function (eachdata) {
     if (eachdata.channel) {

src/service/conceptService.js

@@ -21,7 +21,7 @@ var responseCode = messageUtils.RESPONSE_CODE
  * @param {Object} req
  * @param {Object} response
  */
-function getDomainsAPI(req, response) {
+function getDomainsAPI (req, response) {
   logger.debug({ msg: 'conceptService.getDomainAPI() called' }, req)
   var data = {}
   var rspObj = req.rspObj
@@ -67,7 +67,7 @@ function getDomainsAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function getDomainByIDAPI(req, response) {
+function getDomainByIDAPI (req, response) {
   logger.debug({ msg: 'conceptService.getDomainByIDAPI() called' }, req)
   var data = {}
   var rspObj = req.rspObj
@@ -130,7 +130,7 @@ function getDomainByIDAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function getObjectTypesAPI(req, response) {
+function getObjectTypesAPI (req, response) {
   logger.debug({ msg: 'conceptService.getObjectTypesAPI() called' }, req)
   var data = {}
   var rspObj = req.rspObj
@@ -192,7 +192,7 @@ function getObjectTypesAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function getObjectTypeByIDAPI(req, response) {
+function getObjectTypeByIDAPI (req, response) {
   logger.debug({ msg: 'conceptService.getObjectTypeByIDAPI() called' }, req)
   var data = {}
   var rspObj = req.rspObj
@@ -257,7 +257,7 @@ function getObjectTypeByIDAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function getConceptByIdAPI(req, response) {
+function getConceptByIdAPI (req, response) {
   logger.debug({ msg: 'conceptService.getConceptByIdAPI() called' }, req)
   var data = {}
   var rspObj = req.rspObj
@@ -319,7 +319,7 @@ function getConceptByIdAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function searchObjectTypeAPI(req, response) {
+function searchObjectTypeAPI (req, response) {
   logger.debug({ msg: 'conceptService.searchObjectTypeAPI() called' }, req)
   var rspObj = req.rspObj
   var data = req.body
@@ -387,7 +387,7 @@ function searchObjectTypeAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function createObjectTypeAPI(req, response) {
+function createObjectTypeAPI (req, response) {
   var rspObj = req.rspObj
   logger.debug({ msg: 'conceptService.createObjectTypeAPI() called' }, req)
   var data = req.body
@@ -454,7 +454,7 @@ function createObjectTypeAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function updateObjectTypeAPI(req, response) {
+function updateObjectTypeAPI (req, response) {
   logger.debug({ msg: 'conceptService.updateObjectTypeAPI() called' }, req)
   var rspObj = req.rspObj
   var data = req.body
@@ -523,7 +523,7 @@ function updateObjectTypeAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function retireObjectTypeAPI(req, response) {
+function retireObjectTypeAPI (req, response) {
   logger.debug({ msg: 'conceptService.retireObjectTypeAPI() called' }, req)
   var rspObj = req.rspObj
   var data = req.body
@@ -590,7 +590,7 @@ function retireObjectTypeAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function listTermsAPI(req, response) {
+function listTermsAPI (req, response) {
   logger.debug({ msg: 'conceptService.listTermsAPI() called' }, req)
   var rspObj = req.rspObj
   async.waterfall([
@@ -616,7 +616,7 @@ function listTermsAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function listResourceBundlesAPI(req, response) {
+function listResourceBundlesAPI (req, response) {
   logger.debug({ msg: 'conceptService.listResourceBundlesAPI() called' }, req)
   var rspObj = req.rspObj
   async.waterfall([
@@ -642,7 +642,7 @@ function listResourceBundlesAPI(req, response) {
  * @param {Object} req
  * @param {Object} response
  */
-function listOrdinalsAPI(req, response) {
+function listOrdinalsAPI (req, response) {
   logger.debug({ msg: 'conceptService.listOrdinalsAPI() called' }, req)
   var rspObj = req.rspObj
   async.waterfall([

src/service/contentService.js

@@ -1750,8 +1750,8 @@ function copyContentAPI (req, response) {
   data.contentId = req.params.contentId
   var rspObj = req.rspObj
   var query = {}
-  if (req.query){
-    query = req.query;
+  if (req.query) {
+    query = req.query
   }
 
   logger.debug({
@@ -1908,7 +1908,7 @@ function searchPluginsAPI (req, response, objectType) {
 function validateContentLock (req, response) {
   var rspObj = req.rspObj
   var userId = req.get('x-authenticated-userid')
-  var isRootOrgAdmin = lodash.has(req.body.request, "isRootOrgAdmin") ? req.body.request.isRootOrgAdmin : false
+  var isRootOrgAdmin = lodash.has(req.body.request, 'isRootOrgAdmin') ? req.body.request.isRootOrgAdmin : false
   logger.debug({ msg: 'contentService.validateContentLock() called', additionalInfo: { rspObj } }, req)
   var qs = {
     mode: 'edit'