Skip to content

Run js tests with karma #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
salman2013 wants to merge 20 commits into from
Closed

Run js tests with karma #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
ea94a4f
chore: Initial commit
farhan Feb 24, 2025
123b62b
stable 2
farhan Feb 24, 2025
c6ffebb
stable 3
farhan Feb 25, 2025
a37a985
stable 4, adds css and js files
farhan Feb 25, 2025
e005e04
stable 5, Adds django template html and some js
farhan Feb 26, 2025
93eaece
stable 6: Next > Need to resolve require js erros
farhan Mar 6, 2025
f7b68cf
stable > fixed requirejs loading issue
farhan Mar 7, 2025
da50619
chore: Adds updated js files
farhan May 16, 2025
0112e7d
chore: init npm, webpack configs
farhan May 19, 2025
27b8984
chore: comment some code to avoid error for now
farhan May 27, 2025
cbd38d4
chore: separate out webpack config files
farhan May 27, 2025
b9d6c9e
chore: fix ++
farhan May 27, 2025
6af2750
Merge branch 'main' into extract-video-xblock
kdmccormick Jul 23, 2025
6d6d960
chore: refactored code ++
farhan Jul 24, 2025
981e2a9
chore: improve docs
farhan Aug 5, 2025
448fe3a
chore: run js tests with karma
salman2013 Sep 9, 2025
7ba2932
fix: fix the workflow
salman2013 Sep 9, 2025
6e8ac0d
fix: fix the workflow
salman2013 Sep 9, 2025
640e0ea
fix: fix the workflow
salman2013 Sep 9, 2025
4319fbf
fix: fix the workflow
salman2013 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .github/workflows/js-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Javascript tests

on:
pull_request:
push:
branches:
- '**'

jobs:
run_tests:
name: JS
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
node-version: [20]
python-version: ['3.11', '3.12']

steps:
- uses: actions/checkout@v4
- name: Fetch main to compare coverage
run: git fetch --depth=1 origin main

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}

- name: Setup npm
run: npm i -g npm@10.7.x

- name: Install Firefox 123.0
run: |
sudo apt-get purge firefox
wget "https://ftp.mozilla.org/pub/firefox/releases/123.0/linux-x86_64/en-US/firefox-123.0.tar.bz2"
tar -xjf firefox-123.0.tar.bz2
sudo mv firefox /opt/firefox
sudo ln -s /opt/firefox/firefox /usr/bin/firefox

- name: Install Required System Packages
run: sudo apt-get update && sudo apt-get install -y libxmlsec1-dev ubuntu-restricted-extras xvfb

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

- name: Get pip cache dir
id: pip-cache-dir
run: |
echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT

- name: Cache pip dependencies
id: cache-dependencies
uses: actions/cache@v4
with:
path: ${{ steps.pip-cache-dir.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('requirements/edx/base.txt') }}
restore-keys: ${{ runner.os }}-pip-

- name: Install Required Python Dependencies
run: |
pip install -r requirements/base.txt

- name: Install npm
working-directory: ./xblocks_contrib/video
run: npm ci

- name: Run JS Tests
working-directory: ./xblocks_contrib/video
run: |
npm run test

- name: Save Job Artifacts
uses: actions/upload-artifact@v4
with:
name: Build-Artifacts
path: |
reports/**/*
test_root/log/*.png
test_root/log/*.log
**/TEST-*.xml
overwrite: true
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ __pycache__
/lib
/lib64

# node
node_modules
npm-debug.log

# Installer logs
pip-log.txt

Expand Down
5 changes: 4 additions & 1 deletion requirements/base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ django-statici18n
edx-i18n-tools
XBlock
openedx-django-pyfs
# TODO: Run python reqs update
edx-django-utils>=5.14.1
edxval
nh3
oauthlib
edx-opaque-keys
edx-opaque-keys
Empty file added xblocks_contrib/utils/__init__.py
View file
Open in desktop
Empty file.
26 changes: 26 additions & 0 deletions xblocks_contrib/utils/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
def display_name_with_default(block):
"""
Calculates the display name for a block.

Default to the display_name if it isn't None, else fall back to creating
a name based on the URL.

Unlike the rest of this module's functions, this function takes an entire
course block/overview as a parameter. This is because a few test cases
(specifically, {Text|Image|Video}AnnotationModuleTestCase.test_student_view)
create scenarios where course.display_name is not None but course.location
is None, which causes calling course.url_name to fail. So, although we'd
like to just pass course.display_name and course.url_name as arguments to
this function, we can't do so without breaking those tests.

Note: This method no longer escapes as it once did, so the caller must
ensure it is properly escaped where necessary.

Arguments:
block (XModuleMixin|CourseOverview|BlockStructureBlockData):
Block that is being accessed
"""
return (
block.display_name if block.display_name is not None
else block.scope_ids.usage_id.block_id.replace('_', ' ')
)
Loading
Loading